Struct sandkiste_lua::v5_3::LuaDatum

source · [−]

pub struct LuaDatum<'a, 'b, 'c>(_);

Expand description

Lua value (of any supported type)

A LuaDatum is used to pass values from Rust to Lua and vice versa. It can contain values of several types (dynamic typing). See module sandkiste::types for more information.

Lifetimes

Lifetime argument 'a corresponds to the lifetime argument 'a of LuaMachine. It is a lower bound for closures passed to the Lua machine.

Lifetime argument 'b corresponds to the lifetime of the shared reference to the LuaMachine being worked with.

Lifetime argument 'c is often 'static but can be a shorter lifetime for temporary LuaDatums created from a &'c str reference, for example.

Trait Implementations

impl<'a, 'b, 'c> Clone for LuaDatum<'a, 'b, 'c>

fn clone(&self) -> LuaDatum<'a, 'b, 'c>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<'a, 'b, 'c> Debug for LuaDatum<'a, 'b, 'c>

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

Formats the value using the given formatter. Read more

impl<'a, 'b, 'c> From<&'c [u8 ]> for LuaDatum<'a, 'b, 'c>

fn from(value: &'c [u8 ]) -> LuaDatum<'a, 'b, 'c>

Converts to this type from the input type.

impl<'a, 'b, 'c> From<&'c str> for LuaDatum<'a, 'b, 'c>

fn from(value: &'c str) -> LuaDatum<'a, 'b, 'c>

Converts to this type from the input type.

impl<'a, 'b, 'c> From<String> for LuaDatum<'a, 'b, 'c>

fn from(value: String) -> LuaDatum<'a, 'b, 'c>

Converts to this type from the input type.

impl<'a, 'b, 'c> From<Vec<u8, Global>> for LuaDatum<'a, 'b, 'c>

fn from(value: Vec<u8>) -> LuaDatum<'a, 'b, 'c>

Converts to this type from the input type.

impl<'a, 'b, 'c> From<bool> for LuaDatum<'a, 'b, 'c>

fn from(value: bool) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> From<f32> for LuaDatum<'a, 'b, 'c>

fn from(value: f32) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> From<f64> for LuaDatum<'a, 'b, 'c>

fn from(value: f64) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> From<i16> for LuaDatum<'a, 'b, 'c>

fn from(value: i16) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> From<i32> for LuaDatum<'a, 'b, 'c>

fn from(value: i32) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> From<i8> for LuaDatum<'a, 'b, 'c>

fn from(value: i8) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> From<u16> for LuaDatum<'a, 'b, 'c>

fn from(value: u16) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> From<u8> for LuaDatum<'a, 'b, 'c>

fn from(value: u8) -> Self

Converts to this type from the input type.

impl<'a, 'b, 'c> MaybeArray for LuaDatum<'a, 'b, 'c>

type Element<'d> = LuaDatum<'a, 'b, 'd>

Type of elements

fn try_array(&self) -> Result<(), DatumViewError>

Return error unless datum is an array-like type

fn array_len(&self) -> Result<usize, MachineError>

Array length

fn array_get(
&self,
index: usize
) -> Result<LuaDatum<'a, 'b, 'static>, MachineError>

Retrieve element at index Read more

fn array_set<'d>(
    &self,
    index: usize,
    element: LuaDatum<'a, 'b, 'd>
) -> Result<(), MachineError>

Set element at index Read more

fn array_push<'d>(
&self,
element: LuaDatum<'a, 'b, 'd>
) -> Result<(), MachineError>

Push element to array

fn array_truncate(&self, len: usize) -> Result<(), MachineError>

Truncate array

fn array_to_iter(&'b self) -> Result<ArrayIter<'b, Self>, MachineError>

Create Iterator over entries of array-like datum

fn array_to_vec(
&self,
maxlen: usize
) -> Result<Vec<Self::Element<'static>, Global>, MachineError>

Create Vec from array-like datum

impl<'a, 'b, 'c> MaybeBinary<'c> for LuaDatum<'a, 'b, 'c>

fn try_as_bin(&self) -> Result<&[u8 ], DatumViewError>

Try to interpret datum as binary (8 bit) string

fn try_into_binary(self) -> Result<Vec<u8, Global>, DatumConversionError<Self>>

Try to convert datum into binary (8 bit) string

impl<'a, 'b, 'c> MaybeBoolean for LuaDatum<'a, 'b, 'c>

fn try_as_bool(&self) -> Result<bool, DatumViewError>

Try to interpret datum as boolean value

impl<'a, 'b, 'c> MaybeFloat for LuaDatum<'a, 'b, 'c>

fn try_as_f64(&self) -> Result<f64, DatumViewError>

Try to interpret datum as f64

fn try_as_f32(&self) -> Result<f32, DatumViewError>

Try to interpret datum as f64

impl<'a, 'b, 'c> MaybeFunction for LuaDatum<'a, 'b, 'c>

type Function = LuaFunction<'a, 'b>

Function type (see Machine::Function)

fn from_function(value: LuaFunction<'a, 'b>) -> Self

Convert from Machine::Function

fn try_as_function(&self) -> Result<&LuaFunction<'a, 'b>, DatumViewError>

Try to interpret datum as function

type FunctionRef<'a>
where
<Self::FunctionRef<'a> as Deref>::Target == Self::Function = &'a Self::Function

Reference or smart pointer to MaybeFunction::Function as returned by try_as_function Read more

impl<'a, 'b, 'c> MaybeInteger for LuaDatum<'a, 'b, 'c>

fn try_as_i64(&self) -> Result<i64, DatumViewError>

Try to interpret datum as i64

fn try_as_u64(&self) -> Result<u64, DatumViewError>

Try to interpret datum as u64

fn try_as_i32(&self) -> Result<i32, DatumViewError>

Try to interpret datum as i32

fn try_as_u32(&self) -> Result<u32, DatumViewError>

Try to interpret datum as u32

fn try_as_i16(&self) -> Result<i16, DatumViewError>

Try to interpret datum as i16

fn try_as_u16(&self) -> Result<u16, DatumViewError>

Try to interpret datum as u16

fn try_as_i8(&self) -> Result<i8, DatumViewError>

Try to interpret datum as i8

fn try_as_u8(&self) -> Result<u8, DatumViewError>

Try to interpret datum as u8

fn try_as_isize(&self) -> Result<usize, DatumViewError>

Try to interpret datum as isize

fn try_as_usize(&self) -> Result<usize, DatumViewError>

Try to interpret datum as usize

impl<'a, 'b, 'c> MaybeOpaque for LuaDatum<'a, 'b, 'c>

type Opaque = LuaReference<'a, 'b>

Type used to represent reference to an opaque datum

fn try_as_opaque(&self) -> Result<&LuaReference<'a, 'b>, DatumViewError>

Try to interpret datum as reference to opaque datum

type OpaqueRef<'a>
where
<Self::OpaqueRef<'a> as Deref>::Target == Self::Opaque = &'a Self::Opaque

Reference or smart pointer to MaybeOpaque::Opaque as returned by try_as_opaque Read more

impl<'a, 'b, 'c> MaybeString<'c> for LuaDatum<'a, 'b, 'c>

fn try_as_str(&self) -> Result<&str, DatumViewError>

Try to interpret datum as Unicode string

fn try_into_string(self) -> Result<String, DatumConversionError<Self>>

Try to convert datum into Unicode string

impl<'a, 'b, 'c> MaybeStringMap for LuaDatum<'a, 'b, 'c>

type Value<'d> = LuaDatum<'a, 'b, 'd>

Type of values

fn try_string_map(&self) -> Result<(), DatumViewError>

Return error unless datum is a string-map-like type

fn string_map_get(
&self,
key: &str
) -> Result<LuaDatum<'a, 'b, 'static>, MachineError>

Get entry from string map

fn string_map_set<'d, 'e>(
    &self,
    key: &'d str,
    value: LuaDatum<'a, 'b, 'e>
) -> Result<(), MachineError>

Set entry in string map

impl<'a, 'b, 'c> Nullable for LuaDatum<'a, 'b, 'c>

fn null() -> Self

Datum representing a null value

fn is_null(&self) -> bool

Can the datum be interpreted as a null value?

impl<'a, 'b, 'c> TryFrom<LuaDatum<'a, 'b, 'c>> for String

type Error = DatumConversionError<LuaDatum<'a, 'b, 'c>>

The type returned in the event of a conversion error.

fn try_from(value: LuaDatum<'a, 'b, 'c>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b, 'c> TryFrom<LuaDatum<'a, 'b, 'c>> for Vec<u8>

type Error = DatumConversionError<LuaDatum<'a, 'b, 'c>>

The type returned in the event of a conversion error.

fn try_from(value: LuaDatum<'a, 'b, 'c>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b, 'c> TryFrom<i64> for LuaDatum<'a, 'b, 'c>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b, 'c> TryFrom<isize> for LuaDatum<'a, 'b, 'c>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b, 'c> TryFrom<u32> for LuaDatum<'a, 'b, 'c>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b, 'c> TryFrom<u64> for LuaDatum<'a, 'b, 'c>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, 'b, 'c> TryFrom<usize> for LuaDatum<'a, 'b, 'c>

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations

impl<'a, 'b, 'c> RefUnwindSafe for LuaDatum<'a, 'b, 'c>

impl<'a, 'b, 'c> !Send for LuaDatum<'a, 'b, 'c>

impl<'a, 'b, 'c> !Sync for LuaDatum<'a, 'b, 'c>

impl<'a, 'b, 'c> Unpin for LuaDatum<'a, 'b, 'c>

impl<'a, 'b, 'c> UnwindSafe for LuaDatum<'a, 'b, 'c>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.