Struct tarantool::tuple::Tuple

pub struct Tuple { /* private fields */ }

Tuple

Implementations

impl Tuple

pub fn from_struct<T>(value: &T) -> Result<Self> where
    T: AsTuple, 

Creates new tuple from value.

This function will serialize structure instance value of type T into tuple internal representation

See also: AsTuple

pub unsafe fn from_raw_data(data: *mut c_char, len: u32) -> Self

Safety

data must point to a buffer containing len bytes representing a valid messagepack array

pub unsafe fn from_slice(data: &[u8]) -> Self

Safety

data must represent a valid messagepack array

pub fn try_from_slice(data: &[u8]) -> Result<Self>

pub fn from_ptr(ptr: NonNull<BoxTuple>) -> Self

pub fn try_from_ptr(ptr: *mut BoxTuple) -> Option<Self>

pub fn len(&self) -> u32

Return the number of fields in tuple (the size of MsgPack Array).

pub fn is_empty(&self) -> bool

pub fn bsize(&self) -> usize

Will return the number of bytes in the tuple.

With both the memtx storage engine and the vinyl storage engine the default maximum is one megabyte (memtx_max_tuple_size or vinyl_max_tuple_size). Every field has one or more “length” bytes preceding the actual contents, so bsize() returns a value which is slightly greater than the sum of the lengths of the contents.

The value does not include the size of “struct tuple” (for the current size of this structure look in the tuple.h file in Tarantool’s source code).

pub fn format(&self) -> TupleFormat

Return the associated format.

pub fn iter(&self) -> Result<TupleIterator>

Allocate and initialize a new Tuple iterator. The Tuple iterator allow to iterate over fields at root level of MsgPack array.

Example:

let mut it = tuple.iter().unwrap();

while let Some(field) = it.next::<T>().unwrap() {
    // process data
}

// rewind iterator to first position
it.rewind();
assert!(it.position() == 0);

// rewind iterator to first position
let field = it.seek::<T>(3).unwrap();
assert!(it.position() == 4);
}

pub fn field<'a, T>(&'a self, fieldno: u32) -> Result<Option<T>> where
    T: Deserialize<'a>, 

Deserialize a tuple field specified by zero-based array index.

• fieldno - zero-based index in MsgPack array.

Returns:

• Ok(None) if fieldno >= self.len()
• Err(e) if deserialization failed
• Ok(Some(field value)) otherwise

See also Tuple::try_get, Tuple::get.

pub fn try_get<'a, I, T>(&'a self, key: I) -> Result<Option<T>> where
    I: TupleIndex,
    T: Deserialize<'a>, 

Deserialize a tuple field specified by an index implementing TupleIndex trait.

Currently 2 types of indexes are supported:

• u32 - zero-based index in MsgPack array (See also Tuple::field)
• &str - JSON path for tuples with non default formats

Returns:

• Ok(None) if index wasn’t found
• Err(e) if deserialization failed
• Ok(Some(field value)) otherwise

See also Tuple::get.

pub fn get<'a, I, T>(&'a self, key: I) -> Option<T> where
    I: TupleIndex,
    T: Deserialize<'a>, 

Deserialize a tuple field specified by an index implementing TupleIndex trait.

Currently 2 types of indexes are supported:

• u32 - zero-based index in MsgPack array (See also Tuple::field)
• &str - JSON path for tuples with non default formats

Returns:

• None if index wasn’t found
• panics if deserialization failed
• Some(field value) otherwise

See also Tuple::get.

pub fn as_struct<T>(&self) -> Result<T> where
    T: DeserializeOwned, 

Deserializes tuple contents into structure of type T

pub fn into_struct<T>(self) -> Result<T> where
    T: DeserializeOwned, 

Deserializes tuple contents into structure of type T

Trait Implementations

impl Clone for Tuple

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tuple

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decode for Tuple

fn decode(data: &[u8]) -> Result<Self>

impl Drop for Tuple

fn drop(&mut self)

Executes the destructor for this type.

impl From<&'_ FunctionArgs> for Tuple

fn from(args: &FunctionArgs) -> Tuple

Converts to this type from the input type.

impl From<&'_ TupleBuffer> for Tuple

fn from(buf: &TupleBuffer) -> Self

Converts to this type from the input type.

impl From<FunctionArgs> for Tuple

fn from(args: FunctionArgs) -> Tuple

Converts to this type from the input type.

impl From<Tuple> for TupleBuffer

fn from(t: Tuple) -> Self

Converts to this type from the input type.

impl<L> LuaRead<L> for Tuple where
    L: AsLua, 

fn lua_read_at_position(lua: L, index: NonZeroI32) -> Result<Self, L>

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

fn lua_read(lua: L) -> Result<Self, L>

Reads the data from Lua.

fn lua_read_at_maybe_zero_position(lua: L, index: i32) -> Result<Self, L>

impl<L> Push<L> for Tuple where
    L: AsLua, 

type Err = Void

Error that can happen when pushing a value.

fn push_to_lua(&self, lua: L) -> PushResult<L, Self>

Pushes the value on the top of the stack.

fn push_no_err(&self, lua: L) -> PushGuard<L> where
    Self::Err: Into<Void>, 

Same as push_to_lua but can only succeed and is only available if Err implements Into<Void>.

impl<L> PushOne<L> for Tuple where
    L: AsLua,