| Overview |  |
Copyright © 2013, Andreas Stenius
Authors: Andreas Stenius (kaos@astekk.se).
Everything object.
Structs.. structs.. and more structs.field_name() = ecapnp:field_name()
field_type() = ecapnp:field_type()
object() = ecapnp:object()
schema_node() = ecapnp:schema_node()
segment_id() = ecapnp:segment_id()
type_name() = ecapnp:type_name()
| add_ref/2 | |
| alloc/3 | Allocate data for a new object. |
| copy/1 | Copy object recursively. |
| discard_ref/2 | |
| field/2 | Lookup field definition by name for object. |
| from_data/2 | |
| from_data/3 | Get object (or list) from data. |
| from_ref/3 | Get object (or list) from reference. |
| get_cap_table/1 | |
| init/1 | |
| init/2 | |
| refresh/1 | Reread object reference. |
| set_cap_table/2 | |
| to_data/1 | Type cast object to binary data. |
| to_list/2 | Type cast object to list of type. |
| to_struct/2 | Type cast object to another type of object. |
| to_text/1 | Type cast object to text. |
add_ref(Ref, Object) -> any()
alloc(Node::schema_node(), SegmentId::segment_id(), Data::pid()) -> object()
Allocate data for a new object.
copy(Object::object()) -> binary()
Copy object recursively.
discard_ref(Ref, Object) -> any()
field(NameOrId::field_name() | non_neg_integer() | {ptr, non_neg_integer()}, Object::object()) -> field_type()
Lookup field definition by name for object.
from_data(Data, Type) -> any()
from_data(Data::binary() | [binary()], Type::type_name(), Schema::term()) -> object() | list()
Get object (or list) from data.
Returns a reader object (i.e. a read-only version).See also: from_ref/2.
from_ref(Ref::#ref{segment = undefined | ecapnp:segment_id(), pos = ecapnp:segment_pos(), offset = ecapnp:segment_offset(), align = ecapnp:bit_count(), kind = ecapnp:ref_kind(), data = undefined | #builder{pid = undefined | pid()} | #reader{data = undefined | [binary()] | binary(), caps = list()}}, Type::type_name(), Schema::term()) -> object() | list()
Get object (or list) from reference. from ref doesn't work well as it doesn't preserve/keep the schema module name..
get_cap_table(Object) -> any()
init(Object) -> any()
init(Ref, Type) -> any()
Reread object reference.
See also: ecapnp_ref:refresh/1.
set_cap_table(CapTable, Object) -> any()
to_data(Object::object()) -> binary()
Type cast object to binary data. Object must be a reference to data.
to_list(Type::type_name(), Object::object()) -> list()
Type cast object to list of type. Object must be a reference to a list.
to_struct(Type::type_name(), Object::object()) -> object()
Type cast object to another type of object.
to_text(Object::object()) -> binary()
Type cast object to text. Object must be a reference to text.
Generated by EDoc, May 30 2014, 12:56:28.