Struct tlua::Strict

pub struct Strict<T>(pub T);

A wrapper type for reading lua numbers of concrete precisions without implicit coercions.

By default when reading a numeric type (int or float) from a lua number (i.e. calling LuaRead::lua_read_at_position) the resulting number will be implicitly coerced into the target type. For example if the lua number has a non zero fractional part it will be discarded when reading the number as integer.

use tlua::Lua;
let lua = tlua::Lua::new();
let i: Option<i32> = lua.eval("return 3.14").ok();
assert_eq!(i, Some(3));

If you don’t want the implicit coercision, you can use the Strict wrapper:

use tlua::Strict;
let i: Option<Strict<i32>> = lua.eval("return 3.14").ok();
assert_eq!(i, None); // would result in loss of data

let f: Option<Strict<f64>> = lua.eval("return 3.14").ok();
assert_eq!(f, Some(Strict(3.14))); // ok

This strictness also applies in terms of number sizes:

let i: Option<u8> = lua.eval("return 256").ok();
assert_eq!(i, Some(0)); // non-strict => data loss

let i: Option<Strict<u8>> = lua.eval("return 256").ok();
assert_eq!(i, None); // strict => must not lose data

let i: Option<Strict<u16>> = lua.eval("return 256").ok();
assert_eq!(i, Some(Strict(256))); // strict => no data loss

Reading cdata

This type only supports regular lua numbers. If you want to read a luajit cdata type, use the CData wrapper instead.

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for Strict<T>

fn clone(&self) -> Strict<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Strict<T>

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

Formats the value using the given formatter.

impl<T> From<T> for Strict<T>

fn from(v: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Strict<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<L> LuaRead<L> for Strict<f32>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<f64>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<i16>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<i32>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<i64>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<i8>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<isize>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<u16>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<u32>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<u64>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<u8>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L> LuaRead<L> for Strict<usize>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<T: Ord> Ord for Strict<T>

fn cmp(&self, other: &Strict<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Strict<T>

fn eq(&self, other: &Strict<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Strict<T>

fn partial_cmp(&self, other: &Strict<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy> Copy for Strict<T>

impl<T: Eq> Eq for Strict<T>

impl<T> StructuralEq for Strict<T>

impl<T> StructuralPartialEq for Strict<T>