Enum Variant 

#[non_exhaustive]
pub enum Variant<'de> {
    Bool(bool),
    U8(u8),
    I16(i16),
    U16(u16),
    I32(i32),
    U32(u32),
    I64(i64),
    U64(u64),
    F64(f64),
    String(&'de str),
    ObjectPath(&'de ObjectPath),
    Signature(&'de Signature),
}

A variant holding a value of a basic D-Bus type.

A variant is a value which is prefixed by the Signature of the value it contains, which allows a container to hold values of a type which is not known ahead of time.

Containers inside of a variant cannot be represented by this type. To write one use BodyBuf::store_variant, and to read one use Body::skip_variant to skip over it.

Examples

use tokio_dbus::{BodyBuf, Variant};

let mut body = BodyBuf::new();

body.store(Variant::String("Hello World!"))?;
body.store(Variant::Bool(true))?;

assert_eq!(body.signature(), "vv");

let mut body = body.as_body();
assert!(matches!(body.read_variant()?, Variant::String("Hello World!")));
assert!(matches!(body.read_variant()?, Variant::Bool(true)));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bool(bool)

A boolean variant.

U8(u8)

A single byte variant.

I16(i16)

A signed 16-bit variant.

U16(u16)

An unsigned 16-bit variant.

I32(i32)

A signed 32-bit variant.

U32(u32)

An unsigned 32-bit variant.

I64(i64)

A signed 64-bit variant.

U64(u64)

An unsigned 64-bit variant.

F64(f64)

A 64-bit floating point variant.

String(&'de str)

A string variant.

ObjectPath(&'de ObjectPath)

An object path variant.

Signature(&'de Signature)

A stored signature.

Implementations

impl Variant<'_>

pub fn contained_signature(&self) -> &'static Signature

The signature of the value contained in this variant.

Examples

use tokio_dbus::{Signature, Variant};

assert_eq!(Variant::Bool(true).contained_signature(), Signature::BOOLEAN);
assert_eq!(Variant::String("hi").contained_signature(), Signature::STRING);

Trait Implementations

impl<'de> Clone for Variant<'de>

fn clone(&self) -> Variant<'de>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Copy for Variant<'de>

impl<'de> Debug for Variant<'de>

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

Formats the value using the given formatter.

impl<'de> PartialEq for Variant<'de>

fn eq(&self, other: &Variant<'de>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Storable for Variant<'_>

impl<'de> StructuralPartialEq for Variant<'de>