Struct VariantType

pub struct VariantType { /* private fields */ }

Describes Variant types.

The Variant type system (based on the D-Bus one) describes types with “type strings”. VariantType is an owned immutable type string (you can think of it as a Box<str> statically guaranteed to be a valid type string), &VariantTy is a borrowed one (like &str).

Implementations

impl VariantType

pub fn new(type_string: &str) -> Result<VariantType, BoolError>

Tries to create a VariantType from a string slice.

Returns Ok if the string is a valid type string, Err otherwise.

pub fn new_dict_entry( key_type: &VariantTy, value_type: &VariantTy, ) -> VariantType

Creates a VariantType from a key and value type.

pub fn new_array(elem_type: &VariantTy) -> VariantType

Creates a VariantType from an array element type.

pub fn new_maybe(child_type: &VariantTy) -> VariantType

Creates a VariantType from a maybe element type.

pub fn new_tuple( items: impl IntoIterator<Item = impl AsRef<VariantTy>>, ) -> VariantType

Creates a VariantType from a maybe element type.

pub fn from_string( type_string: impl Into<GString>, ) -> Result<VariantType, BoolError>

Tries to create a VariantType from an owned string.

Returns Ok if the string is a valid type string, Err otherwise.

Methods from Deref<Target = VariantTy>

pub const BOOLEAN: &'static VariantTy = _

pub const BYTE: &'static VariantTy = _

pub const INT16: &'static VariantTy = _

pub const UINT16: &'static VariantTy = _

pub const INT32: &'static VariantTy = _

pub const UINT32: &'static VariantTy = _

pub const INT64: &'static VariantTy = _

pub const UINT64: &'static VariantTy = _

pub const DOUBLE: &'static VariantTy = _

pub const STRING: &'static VariantTy = _

pub const OBJECT_PATH: &'static VariantTy = _

pub const SIGNATURE: &'static VariantTy = _

pub const VARIANT: &'static VariantTy = _

pub const HANDLE: &'static VariantTy = _

pub const UNIT: &'static VariantTy = _

pub const ANY: &'static VariantTy = _

pub const BASIC: &'static VariantTy = _

pub const MAYBE: &'static VariantTy = _

pub const ARRAY: &'static VariantTy = _

pub const TUPLE: &'static VariantTy = _

pub const DICT_ENTRY: &'static VariantTy = _

pub const DICTIONARY: &'static VariantTy = _

pub const STRING_ARRAY: &'static VariantTy = _

pub const OBJECT_PATH_ARRAY: &'static VariantTy = _

pub const BYTE_STRING: &'static VariantTy = _

pub const BYTE_STRING_ARRAY: &'static VariantTy = _

pub const VARDICT: &'static VariantTy = _

pub fn as_str(&self) -> &str

Converts to a string slice.

pub fn is_definite(&self) -> bool

Check if this variant type is a definite type.

pub fn is_container(&self) -> bool

Check if this variant type is a container type.

pub fn is_basic(&self) -> bool

Check if this variant type is a basic type.

pub fn is_maybe(&self) -> bool

Check if this variant type is a maybe type.

pub fn is_array(&self) -> bool

Check if this variant type is an array type.

pub fn is_tuple(&self) -> bool

Check if this variant type is a tuple type.

pub fn is_dict_entry(&self) -> bool

Check if this variant type is a dict entry type.

pub fn is_variant(&self) -> bool

Check if this variant type is a variant.

pub fn is_subtype_of(&self, supertype: &Self) -> bool

Check if this variant type is a subtype of another.

pub fn element(&self) -> &VariantTy

Return the element type of this variant type.

Panics

This function panics if not called with an array or maybe type.

pub fn tuple_types(&self) -> VariantTyIterator<'_>

Iterate over the types of this variant type.

Panics

This function panics if not called with a tuple or dictionary entry type.

pub fn first(&self) -> Option<&VariantTy>

Return the first type of this variant type.

Panics

This function panics if not called with a tuple or dictionary entry type.

pub fn next(&self) -> Option<&VariantTy>

Return the next type of this variant type.

pub fn n_items(&self) -> usize

Return the number of items in this variant type.

pub fn key(&self) -> &VariantTy

Return the key type of this variant type.

Panics

This function panics if not called with a dictionary entry type.

pub fn value(&self) -> &VariantTy

Return the value type of this variant type.

Panics

This function panics if not called with a dictionary entry type.

Trait Implementations

impl AsRef<VariantTy> for VariantType

fn as_ref(&self) -> &VariantTy

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

impl Borrow<VariantTy> for VariantType

fn borrow(&self) -> &VariantTy

Immutably borrows from an owned value.

impl Clone for VariantType

fn clone(&self) -> VariantType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariantType

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

Formats the value using the given formatter.

impl Deref for VariantType

type Target = VariantTy

The resulting type after dereferencing.

fn deref(&self) -> &VariantTy

Dereferences the value.

impl Display for VariantType

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

Formats the value using the given formatter.

impl Drop for VariantType

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<VariantType> for Cow<'a, VariantTy>

fn from(ty: VariantType) -> Cow<'a, VariantTy>

Converts to this type from the input type.

impl FromStr for VariantType

type Err = BoolError

The associated error which can be returned from parsing.

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

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

impl Hash for VariantType

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, 'b> PartialEq<&'a VariantTy> for VariantType

fn eq(&self, other: &&'a VariantTy) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<&'a str> for VariantType

fn eq(&self, other: &&'a str) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<Cow<'a, VariantTy>> for VariantType

fn eq(&self, other: &Cow<'a, VariantTy>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<String> for VariantType

fn eq(&self, other: &String) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<VariantTy> for VariantType

fn eq(&self, other: &VariantTy) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<VariantType> for &'a VariantTy

fn eq(&self, other: &VariantType) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<VariantType> for &'a str

fn eq(&self, other: &VariantType) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<VariantType> for Cow<'a, VariantTy>

fn eq(&self, other: &VariantType) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<VariantType> for String

fn eq(&self, other: &VariantType) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<VariantType> for VariantTy

fn eq(&self, other: &VariantType) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<VariantType> for str

fn eq(&self, other: &VariantType) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, 'b> PartialEq<str> for VariantType

fn eq(&self, other: &str) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for VariantType

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl StaticType for VariantType

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for VariantType

impl Send for VariantType

impl Sync for VariantType