Struct glib::VariantType

source ·
pub struct VariantType { /* private fields */ }
Expand description

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§

source§

impl VariantType

source

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.

source

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

Creates a VariantType from a key and value type.

source

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

Creates a VariantType from an array element type.

source

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

Creates a VariantType from a maybe element type.

source

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

Creates a VariantType from a maybe element type.

source

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>§

source

pub const BOOLEAN: &'static VariantTy = _

source

pub const BYTE: &'static VariantTy = _

source

pub const INT16: &'static VariantTy = _

source

pub const UINT16: &'static VariantTy = _

source

pub const INT32: &'static VariantTy = _

source

pub const UINT32: &'static VariantTy = _

source

pub const INT64: &'static VariantTy = _

source

pub const UINT64: &'static VariantTy = _

source

pub const DOUBLE: &'static VariantTy = _

source

pub const STRING: &'static VariantTy = _

source

pub const OBJECT_PATH: &'static VariantTy = _

source

pub const SIGNATURE: &'static VariantTy = _

source

pub const VARIANT: &'static VariantTy = _

source

pub const HANDLE: &'static VariantTy = _

source

pub const UNIT: &'static VariantTy = _

source

pub const ANY: &'static VariantTy = _

source

pub const BASIC: &'static VariantTy = _

source

pub const MAYBE: &'static VariantTy = _

source

pub const ARRAY: &'static VariantTy = _

source

pub const TUPLE: &'static VariantTy = _

source

pub const DICT_ENTRY: &'static VariantTy = _

source

pub const DICTIONARY: &'static VariantTy = _

source

pub const STRING_ARRAY: &'static VariantTy = _

source

pub const OBJECT_PATH_ARRAY: &'static VariantTy = _

source

pub const BYTE_STRING: &'static VariantTy = _

source

pub const BYTE_STRING_ARRAY: &'static VariantTy = _

source

pub const VARDICT: &'static VariantTy = _

source

pub fn as_str(&self) -> &str

Converts to a string slice.

source

pub fn is_definite(&self) -> bool

Check if this variant type is a definite type.

source

pub fn is_container(&self) -> bool

Check if this variant type is a container type.

source

pub fn is_basic(&self) -> bool

Check if this variant type is a basic type.

source

pub fn is_maybe(&self) -> bool

Check if this variant type is a maybe type.

source

pub fn is_array(&self) -> bool

Check if this variant type is an array type.

source

pub fn is_tuple(&self) -> bool

Check if this variant type is a tuple type.

source

pub fn is_dict_entry(&self) -> bool

Check if this variant type is a dict entry type.

source

pub fn is_variant(&self) -> bool

Check if this variant type is a variant.

source

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

Check if this variant type is a subtype of another.

source

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.

source

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.

source

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.

source

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

Return the next type of this variant type.

source

pub fn n_items(&self) -> usize

Return the number of items in this variant type.

source

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.

source

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§

source§

impl AsRef<VariantTy> for VariantType

source§

fn as_ref(&self) -> &VariantTy

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

impl Borrow<VariantTy> for VariantType

source§

fn borrow(&self) -> &VariantTy

Immutably borrows from an owned value. Read more
source§

impl Clone for VariantType

source§

fn clone(&self) -> VariantType

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
source§

impl Debug for VariantType

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for VariantType

§

type Target = VariantTy

The resulting type after dereferencing.
source§

fn deref(&self) -> &VariantTy

Dereferences the value.
source§

impl Display for VariantType

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for VariantType

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

impl FromStr for VariantType

§

type Err = BoolError

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl Hash for VariantType

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

impl PartialEq<VariantType> for VariantType

source§

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

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

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.
source§

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

source§

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

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

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.
source§

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

source§

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

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

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.
source§

impl StaticType for VariantType

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for VariantType

source§

impl Send for VariantType

source§

impl Sync for VariantType

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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.

source§

impl<T> StaticTypeExt for Twhere T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToClosureReturnValue for Twhere T: ToValue,

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<T> ToSendValue for Twhere T: Send + ToValue + ?Sized,

source§

fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere 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.
source§

impl<T> TryFromClosureReturnValue for Twhere T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for Twhere 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.
source§

impl<'a, T, C> FromValueOptional<'a> for Twhere T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,