Module tarantool::tuple

Tuples

The tuple submodule provides read-only access for the tuple userdata type. It allows, for a single tuple: selective retrieval of the field contents, retrieval of information about size, iteration over all the fields, and conversion from/to rust structures

See also:

• Tuples
• Lua reference: Submodule box.tuple
• C API reference: Module tuple

Re-exports

• pub use rmp;

Structs

• FunctionArgs
  FunctionArgs
• FunctionCtx
  FunctionCtx
• KeyDef
• KeyDefPart
• RawByteBuf
  RawByteBuf A wrapper type for reading raw bytes from a tuple.
• RawBytes
  RawBytes A wrapper type for reading raw bytes from a tuple.
• Tuple
  Tuple
• TupleBuffer
  TupleBuffer Buffer containing tuple contents (MsgPack array)
• TupleFormat
  TupleFormat Tuple format
• TupleIterator
  TupleIterator Tuple iterator

Enums

• FieldType

Traits

• AsTupleDeprecated
  AsTuple Must be implemented for types, which will be used with box access methods as data
• Decode
  Decode Types implementing this trait can be decoded from msgpack.
• DecodeOwned
  Types implementing this trait can be decoded from msgpack by value.
• Encode
  Encode Types implementing this trait can be serialized into a valid tarantool tuple (msgpack array).
• ToTupleBuffer
  ToTupleBuffer Types implementing this trait can be converted to tarantool tuple (msgpack array).
• TupleIndex
  TupleIndex Types implementing this trait can be used as arguments for the Tuple::get method.
• _Encode
  A general purpose trait for msgpack serialization.

Functions

• session_push
  Push MessagePack data into a session data channel - socket, console or whatever is behind the session. Note, that successful push does not guarantee delivery in case it was sent into the network. Just like with write()/send() system calls.

Derive Macros

• Encode
  Macro to automatically derive tarantool::tuple::_Encode Deriving this trait will make this struct encodable into msgpack format. It is meant as a replacement for serde + rmp_serde allowing us to customize it for tarantool case and hopefully also decreasing compile-time due to its simplicity.