Struct wireplumber::lua::LuaVariant

pub struct LuaVariant<'a>(/* private fields */);

Available on crate feature lua only.

A Variant that can be passed to a Lua script.

LuaVariant serves as a sort of adhoc ABI for WirePlumber modules and their configuration data.

Implementations

impl<'a> LuaVariant<'a>

pub fn wrap(v: Variant) -> Result<Self, LuaError>

pub fn borrow(v: &'a Variant) -> Result<Self, LuaError>

pub fn borrowed<'s>(&'s self) -> Self

where 's: 'a,

pub fn owned(&self) -> LuaVariant<'static>

pub fn as_variant(&self) -> &Variant

pub fn inner_ref(&self) -> Result<&'a Variant, &Variant>

pub fn inner_mut(&mut self) -> &mut Variant

pub fn into_variant(self) -> Variant

pub fn into_inner(self) -> Cow<'a, Variant>

impl<'v> LuaVariant<'v>

pub fn nil() -> Self

pub fn convert_from(v: &Variant) -> Result<Self, LuaError>

pub fn with_bytes<B: AsRef<[u8]>>(bytes: B) -> Self

pub fn lua_type(&self) -> LuaType

pub fn lua_value(&self) -> LuaValue<'_>

pub fn flattened(&self) -> Self

pub fn get_nil<'a>(&'a self) -> Option<()>

pub fn get_bool<'a>(&'a self) -> Option<bool>

pub fn get_table<'a>(&'a self) -> Option<LuaTable<'a>>

pub fn get_string(&self) -> Option<LuaString<'_>>

pub fn get_float(&self) -> Option<Result<f64, LuaError>>

pub fn get_integer<T>(&self) -> Option<Result<T, LuaError>>

where T: TryFrom<bool> + TryFrom<u8> + TryFrom<u16> + TryFrom<u32> + TryFrom<u64> + TryFrom<i16> + TryFrom<i32> + TryFrom<i64>, <T as TryFrom<bool>>::Error: Into<LuaError>, <T as TryFrom<u8>>::Error: Into<LuaError>, <T as TryFrom<u16>>::Error: Into<LuaError>, <T as TryFrom<u32>>::Error: Into<LuaError>, <T as TryFrom<u64>>::Error: Into<LuaError>, <T as TryFrom<i16>>::Error: Into<LuaError>, <T as TryFrom<i32>>::Error: Into<LuaError>, <T as TryFrom<i64>>::Error: Into<LuaError>,

Trait Implementations

impl<'a> AsRef<Variant> for LuaVariant<'a>

fn as_ref(&self) -> &Variant

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for LuaVariant<'a>

fn clone(&self) -> LuaVariant<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LuaVariant<'a>

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

Formats the value using the given formatter.

impl<'de, 'v> Deserialize<'de> for LuaVariant<'v>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<'a> Display for LuaVariant<'a>

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

Formats the value using the given formatter.

impl<'a> From<()> for LuaVariant<'a>

fn from(v: ()) -> Self

Converts to this type from the input type.

impl<'a> From<LuaTable<'a>> for LuaVariant<'a>

fn from(v: LuaTable<'a>) -> Self

Converts to this type from the input type.

impl<'v> From<LuaVariant<'v>> for Deserializer<'v>

fn from(v: LuaVariant<'v>) -> Self

Converts to this type from the input type.

impl<'v, 's, S: Into<LuaString<'s>>> From<S> for LuaVariant<'v>

fn from(s: S) -> Self

Converts to this type from the input type.

impl<'a> From<bool> for LuaVariant<'a>

fn from(v: bool) -> Self

Converts to this type from the input type.

impl<'a> From<f64> for LuaVariant<'a>

fn from(v: f64) -> Self

Converts to this type from the input type.

impl<'a> From<i16> for LuaVariant<'a>

fn from(v: i16) -> Self

Converts to this type from the input type.

impl<'a> From<i32> for LuaVariant<'a>

fn from(v: i32) -> Self

Converts to this type from the input type.

impl<'a> From<i64> for LuaVariant<'a>

fn from(v: i64) -> Self

Converts to this type from the input type.

impl<'a> From<u16> for LuaVariant<'a>

fn from(v: u16) -> Self

Converts to this type from the input type.

impl<'a> From<u32> for LuaVariant<'a>

fn from(v: u32) -> Self

Converts to this type from the input type.

impl<'a> From<u64> for LuaVariant<'a>

fn from(v: u64) -> Self

Converts to this type from the input type.

impl<'a, 'v, K: StaticVariantType + Into<LuaVariant<'v>>, V: StaticVariantType + Into<LuaVariant<'v>>> FromIterator<(K, V)> for LuaVariant<'a>

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a, 'v> FromIterator<LuaVariant<'v>> for LuaVariant<'a>

fn from_iter<T: IntoIterator<Item = LuaVariant<'v>>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> FromStr for LuaVariant<'a>

type Err = <Variant as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(str: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a> FromVariant for LuaVariant<'a>

fn from_variant(variant: &Variant) -> Option<Self>

Tries to extract a value.

impl<'a> Hash for LuaVariant<'a>

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<'a> Into<Cow<'a, Variant>> for LuaVariant<'a>

fn into(self) -> Cow<'a, Variant>

Converts this type into the (usually inferred) input type.

impl<'a> Into<Variant> for LuaVariant<'a>

fn into(self) -> Variant

Converts this type into the (usually inferred) input type.

impl<'a, 'de, 'v> IntoDeserializer<'de, LuaError> for &'a LuaVariant<'v>

type Deserializer = Deserializer<'v>

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<'de, 'v> IntoDeserializer<'de, LuaError> for LuaVariant<'v>

type Deserializer = Deserializer<'v>

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<'a, T: AsRef<Variant>> PartialEq<T> for LuaVariant<'a>

fn eq(&self, rhs: &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<'a, T: AsRef<Variant>> PartialOrd<T> for LuaVariant<'a>

fn partial_cmp(&self, rhs: &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<'v> Serialize for LuaVariant<'v>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'a> StaticVariantType for LuaVariant<'a>

fn static_variant_type() -> Cow<'static, VariantTy>

Returns the VariantType corresponding to Self.

impl<'a> ToVariant for LuaVariant<'a>

fn to_variant(&self) -> Variant

Returns a Variant clone of self.

impl<'a> TryFrom<&'a Variant> for LuaVariant<'a>

type Error = LuaError

The type returned in the event of a conversion error.

fn try_from(v: &'a Variant) -> Result<Self, LuaError>

Performs the conversion.

impl<'a> TryFrom<Cow<'a, Variant>> for LuaVariant<'a>

type Error = LuaError

The type returned in the event of a conversion error.

fn try_from(v: Cow<'a, Variant>) -> Result<Self, LuaError>

Performs the conversion.

impl<'a> TryFrom<LuaVariant<'a>> for LuaTable<'a>

type Error = LuaError

The type returned in the event of a conversion error.

fn try_from(v: LuaVariant<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Variant> for LuaVariant<'a>

type Error = LuaError

The type returned in the event of a conversion error.

fn try_from(v: Variant) -> Result<Self, LuaError>

Performs the conversion.

impl<'a> UnsafeFrom<&'a Variant> for LuaVariant<'a>

unsafe fn unsafe_from(v: &'a Variant) -> Self

Safety

impl<'a> UnsafeFrom<Cow<'a, Variant>> for LuaVariant<'a>

unsafe fn unsafe_from(v: Cow<'a, Variant>) -> Self

Safety

impl<'a> UnsafeFrom<LuaVariant<'a>> for LuaTable<'a>

unsafe fn unsafe_from(v: LuaVariant<'a>) -> Self

Safety

impl<'a> UnsafeFrom<Variant> for LuaVariant<'a>

unsafe fn unsafe_from(v: Variant) -> Self

Safety

impl<'a> Eq for LuaVariant<'a>