Skip to main content

Value

Enum Value 

Source
pub enum Value {
Show 16 variants Byte(u8), Bool(bool), I16(i16), U16(u16), I32(i32), U32(u32), I64(i64), U64(u64), Double(f64), Str(String), ObjectPath(String), Signature(String), Array { elem: String, items: Vec<Value>, }, Struct(Vec<Value>), DictEntry(Box<Value>, Box<Value>), Variant(Box<Value>),
}
Expand description

One D-Bus value. Containers carry enough type information to marshal even when empty: an array names its element signature.

Variants§

§

Byte(u8)

y

§

Bool(bool)

b

§

I16(i16)

n

§

U16(u16)

q

§

I32(i32)

i

§

U32(u32)

u

§

I64(i64)

x

§

U64(u64)

t

§

Double(f64)

d

§

Str(String)

s

§

ObjectPath(String)

o

§

Signature(String)

g

§

Array

a…: an array whose items all have the single complete type elem. A dictionary is an array of Value::DictEntry items with an elem such as {sv}.

Fields

§elem: String

The element signature, such as s, (iiay) or {sv}.

§items: Vec<Value>

The items; each must have signature elem.

§

Struct(Vec<Value>)

(…): a struct of one or more fields.

§

DictEntry(Box<Value>, Box<Value>)

{kv}: a dictionary entry; only valid as an array item, with a basic-typed key.

§

Variant(Box<Value>)

v: a value that carries its own signature.

Implementations§

Source§

impl Value

Source

pub fn str(s: impl Into<String>) -> Value

A string value.

Source

pub fn path(p: impl Into<String>) -> Value

An object path value.

Source

pub fn variant(v: Value) -> Value

A variant wrapping v.

Source

pub fn array(elem: impl Into<String>, items: Vec<Value>) -> Value

An array with element signature elem.

Source

pub fn bytes(bytes: &[u8]) -> Value

A byte array (ay).

Source

pub fn strings<S: AsRef<str>>(items: &[S]) -> Value

A string array (as).

Source

pub fn dict( key: &str, value: &str, entries: impl IntoIterator<Item = (Value, Value)>, ) -> Value

A dictionary a{kv} from key and value signatures and its entries.

Source

pub fn props<K: Into<String>>( entries: impl IntoIterator<Item = (K, Value)>, ) -> Value

The a{sv} property dictionary most interfaces use.

Source

pub fn signature(&self) -> String

This value’s D-Bus signature, such as s, a{sv} or (iiay).

Source

pub fn as_str(&self) -> Option<&str>

The string inside a Str, ObjectPath or Signature (looking through variants).

Source

pub fn as_bool(&self) -> Option<bool>

The boolean inside a Bool (looking through variants).

Source

pub fn as_i64(&self) -> Option<i64>

Any integer value widened to i64 (looking through variants); None for a U64 above i64::MAX or a non-integer.

Source

pub fn as_f64(&self) -> Option<f64>

The number inside a Double, or any integer converted (looking through variants).

Source

pub fn as_array(&self) -> Option<&[Value]>

The items of an array (looking through variants).

Source

pub fn as_struct(&self) -> Option<&[Value]>

The fields of a struct (looking through variants).

Source

pub fn unwrap_variant(&self) -> &Value

The value inside a variant, or the value itself when it is not one.

Source

pub fn dict_get(&self, key: &str) -> Option<&Value>

Looks key up in a string-keyed dictionary such as a{sv}; the result is the entry’s value with any variant unwrapped.

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Value

Source§

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

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

impl PartialEq for Value

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Value

Auto Trait Implementations§

§

impl Forget for Value

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnsafeUnpin for Value

§

impl UnwindSafe for Value

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

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> ToOwned for T
where T: Clone,

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.