Module 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

Structs

FunctionArgs

FunctionCtx

KeyDef

An object which describes how to extract a key for a given tarantool index from a tuple. Basically it contains information the parts of the key, specifically location of the parts within the tuple, their types, their nullability and collation.

KeyDefPart

RawByteBuf

A wrapper type for reading raw bytes from a tuple.

RawBytes

A wrapper type for reading raw bytes from a tuple.

Tuple

Tuple

TupleBuffer

Buffer containing tuple contents (MsgPack array)

TupleFormat

Tuple format

TupleIterator

Tuple iterator

Enums

FieldType

Traits

Decode

Types implementing this trait can be decoded from msgpack.

DecodeOwned

Types implementing this trait can be decoded from msgpack by value.

Encode

Types implementing this trait can be serialized into a valid tarantool tuple (msgpack array).

ToTupleBuffer

Types implementing this trait can be converted to tarantool tuple (msgpack array).

TupleIndex

Types implementing this trait can be used as arguments for the Tuple::get method.

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.