Module ecapnp_get

Read support.

Copyright 2013, Andreas Stenius

Authors: Andreas Stenius (kaos@astekk.se).

Description

Read support.

Everything for reading data out of a message.

Data Types

field_name()

field_name() = ecapnp:field_name()

field_value()

field_value() = ecapnp:field_value()

message()

message() = ecapnp:message()

object()

object() = ecapnp:object()

schema()

schema() = ecapnp:schema()

schema_node()

schema_node() = ecapnp:schema_node()

type_name()

type_name() = ecapnp:type_name()

Function Index

field/2Read the field value of object.
ref_data/2internal function not intended for client code.
ref_data/3Read data of object reference as type.
root/2Get the root object for a message.
root/3
union/1Read the unnamed union value of object.

Function Details

field/2

field(FieldName::field_name(), Rpc_call::object()) -> field_value()

Read the field value of object.

See also: ecapnp:get/2.

ref_data/2

ref_data(Ptr, Obj) -> any()

internal function not intended for client code.

ref_data/3

ref_data(Type, Obj, Default) -> any()

Read data of object reference as type. This is a Low-level function.

root/2

root(Node::schema_node(), Segments::message()) -> {ok, Root::object()}

Get the root object for a message.

See also: ecapnp:get_root/3.

root/3

root(Type::type_name(), Schema::schema(), Segments::message()) -> {ok, Root::object()}

union/1

union(Rpc_call::object()) -> {field_name(), field_value()} | field_name()

Read the unnamed union value of object.

See also: ecapnp:get/1.


Generated by EDoc, May 30 2014, 12:56:29.