Enum dbus::arg::messageitem::MessageItem

pub enum MessageItem {
    Array(MessageItemArray),
    Struct(Vec<MessageItem>),
    Variant(Box<MessageItem>),
    Dict(MessageItemDict),
    ObjectPath(Path<'static>),
    Signature(Signature<'static>),
    Str(String),
    Bool(bool),
    Byte(u8),
    Int16(i16),
    Int32(i32),
    Int64(i64),
    UInt16(u16),
    UInt32(u32),
    UInt64(u64),
    Double(f64),
    UnixFd(OwnedFd),
}

MessageItem - used as parameters and return values from method calls, or as data added to a signal (old, enum version).

Note that the newer generic design (see arg module) is both faster and less error prone than MessageItem, and should be your first hand choice whenever applicable.

Variants

Array(MessageItemArray)

A D-Bus array requires all elements to be of the same type. All elements must match the Signature.

Struct(Vec<MessageItem>)

A D-Bus struct allows for values of different types.

Variant(Box<MessageItem>)

A D-Bus variant is a wrapper around another MessageItem, which can be of any type.

Dict(MessageItemDict)

A D-Bus dictionary. All keys and values are required to be of the same type. Not all types can be dictionary keys, but all can be dictionary values.

ObjectPath(Path<'static>)

A D-Bus objectpath requires its content to be a valid objectpath, so this cannot be any string.

Signature(Signature<'static>)

A D-Bus signature requires its content to be a valid type signature, so this cannot be any string.

Str(String)

A D-Bus String is zero terminated, so no \0 s in the String, please. (D-Bus strings are also - like Rust strings - required to be valid UTF-8.)

Bool(bool)

A D-Bus boolean type.

Byte(u8)

A D-Bus unsigned 8 bit type.

Int16(i16)

A D-Bus signed 16 bit type.

Int32(i32)

A D-Bus signed 32 bit type.

Int64(i64)

A D-Bus signed 64 bit type.

UInt16(u16)

A D-Bus unsigned 16 bit type.

UInt32(u32)

A D-Bus unsigned 32 bit type.

UInt64(u64)

A D-Bus unsigned 64 bit type.

Double(f64)

A D-Bus IEEE-754 double-precision floating point type.

UnixFd(OwnedFd)

D-Bus allows for sending file descriptors, which can be used to set up SHM, unix pipes, or other communication channels.

Implementations

impl MessageItem

pub fn signature(&self) -> Signature<'static>

Get the D-Bus Signature for this MessageItem.

pub fn arg_type(&self) -> ArgType

Get the arg type of this MessageItem.

pub fn from_dict<E, I: Iterator<Item = Result<(String, MessageItem), E>>>(
    i: I
) -> Result<MessageItem, E>

Creates a (String, Variant) dictionary from an iterator with Result passthrough (an Err will abort and return that Err)

pub fn new_array(v: Vec<MessageItem>) -> Result<MessageItem, ArrayError>

Creates an MessageItem::Array from a list of MessageItems.

Note: This requires v to be non-empty. See also MessageItem::from(&[T]), which can handle empty arrays as well.

pub fn new_dict(
    v: Vec<(MessageItem, MessageItem)>
) -> Result<MessageItem, ArrayError>

Creates an MessageItem::Dict from a list of MessageItem pairs.

Note: This requires v to be non-empty. See also MessageItem::from(&[(T1, T2)]), which can handle empty arrays as well.

pub fn inner<'a, T: TryFrom<&'a MessageItem>>(&'a self) -> Result<T, T::Error>

Get the inner value of a MessageItem

Example

use dbus::arg::messageitem::MessageItem;
let m: MessageItem = 5i64.into();
let s: i64 = m.inner().unwrap();
assert_eq!(s, 5i64);

pub fn peel(&self) -> &Self

Get the underlying MessageItem of a MessageItem::Variant

Nested MessageItem::Variants are unwrapped recursively until a non-Variant is found.

Example

use dbus::arg::messageitem::MessageItem;
let nested = MessageItem::Variant(Box::new(6i64.into()));
let flat: MessageItem = 6i64.into();
assert_ne!(&nested, &flat);
assert_eq!(nested.peel(), &flat);

Trait Implementations

impl Append for MessageItem

fn append_by_ref(&self, i: &mut IterAppend<'_>)

Performs the append operation by borrowing self.

fn append(self, ia: &mut IterAppend<'_>)where
    Self: Sized,

Performs the append operation by consuming self.

impl Clone for MessageItem

fn clone(&self) -> MessageItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageItem

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

Formats the value using the given formatter.

impl<'a, T1, T2> From<&'a [(T1, T2)]> for MessageItemwhere
    T1: Into<MessageItem> + Clone + Default,
    T2: Into<MessageItem> + Clone + Default,

Create a MessageItem::Dict.

fn from(i: &'a [(T1, T2)]) -> MessageItem

Converts to this type from the input type.

impl<'a, T> From<&'a [T]> for MessageItemwhere
    T: Into<MessageItem> + Clone + Default,

Create a MessageItem::Array.

fn from(i: &'a [T]) -> MessageItem

Converts to this type from the input type.

impl<'a> From<&'a str> for MessageItem

fn from(i: &str) -> MessageItem

Converts to this type from the input type.

impl From<Box<MessageItem, Global>> for MessageItem

Create a MessageItem::Variant

fn from(i: Box<MessageItem>) -> MessageItem

Converts to this type from the input type.

impl From<File> for MessageItem

fn from(i: File) -> MessageItem

Converts to this type from the input type.

impl From<OwnedFd> for MessageItem

fn from(i: OwnedFd) -> MessageItem

Converts to this type from the input type.

impl From<Path<'static>> for MessageItem

fn from(i: Path<'static>) -> MessageItem

Converts to this type from the input type.

impl From<Signature<'static>> for MessageItem

fn from(i: Signature<'static>) -> MessageItem

Converts to this type from the input type.

impl From<String> for MessageItem

fn from(i: String) -> MessageItem

Converts to this type from the input type.

impl From<bool> for MessageItem

fn from(i: bool) -> MessageItem

Converts to this type from the input type.

impl From<f64> for MessageItem

fn from(i: f64) -> MessageItem

Converts to this type from the input type.

impl From<i16> for MessageItem

fn from(i: i16) -> MessageItem

Converts to this type from the input type.

impl From<i32> for MessageItem

fn from(i: i32) -> MessageItem

Converts to this type from the input type.

impl From<i64> for MessageItem

fn from(i: i64) -> MessageItem

Converts to this type from the input type.

impl From<u16> for MessageItem

fn from(i: u16) -> MessageItem

Converts to this type from the input type.

impl From<u32> for MessageItem

fn from(i: u32) -> MessageItem

Converts to this type from the input type.

impl From<u64> for MessageItem

fn from(i: u64) -> MessageItem

Converts to this type from the input type.

impl From<u8> for MessageItem

fn from(i: u8) -> MessageItem

Converts to this type from the input type.

impl<'a> Get<'a> for MessageItem

fn get(i: &mut Iter<'a>) -> Option<Self>

Performs the get operation.

impl PartialEq<MessageItem> for MessageItem

fn eq(&self, other: &MessageItem) -> 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 PartialOrd<MessageItem> for MessageItem

fn partial_cmp(&self, other: &MessageItem) -> 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 RefArg for MessageItem

fn arg_type(&self) -> ArgType

The corresponding D-Bus argument type code.

fn signature(&self) -> Signature<'static>

The corresponding D-Bus type signature for this type.

fn append(&self, i: &mut IterAppend<'_>)

Performs the append operation.

fn as_any(&self) -> &dyn Anywhere
    Self: 'static,

Transforms this argument to Any (which can be downcasted to read the current value).

fn as_any_mut(&mut self) -> &mut dyn Anywhere
    Self: 'static,

Transforms this argument to Any (which can be downcasted to read the current value).

fn box_clone(&self) -> Box<dyn RefArg + 'static>

Deep clone of the RefArg, causing the result to be ’static.

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

Try to read the argument as an i64.

fn as_u64(&self) -> Option<u64>

Try to read the argument as an u64.

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

Try to read the argument as an f64.

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

Try to read the argument as a str.

fn as_iter<'a>(
    &'a self
) -> Option<Box<dyn Iterator<Item = &'a dyn RefArg> + 'a>>

Try to read the argument as an iterator.

fn as_static_inner(&self, _index: usize) -> Option<&(dyn RefArg + 'static)>where
    Self: 'static,

Try to read the inner of an argument, as another argument, specifying an index.

fn array_clone(_arg: &[Self]) -> Option<Box<dyn RefArg + 'static>>where
    Self: Sized,

Deep clone of an array.

impl<'a> TryFrom<&'a MessageItem> for &'a [(MessageItem, MessageItem)]

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a [(MessageItem, MessageItem)], ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a [MessageItem]

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a [MessageItem], ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a Box<MessageItem>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a Box<MessageItem>, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a OwnedFd

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a OwnedFd, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a Path<'static>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a Path<'static>, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a Signature<'static>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a Signature<'static>, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a String

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a String, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a Vec<MessageItem>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a Vec<MessageItem>, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for &'a str

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<&'a str, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for bool

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<bool, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for f64

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<f64, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for i16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<i16, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for i32

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<i32, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for i64

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<i64, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for u16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<u16, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for u32

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<u32, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for u64

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<u64, ()>

Performs the conversion.

impl<'a> TryFrom<&'a MessageItem> for u8

type Error = ()

The type returned in the event of a conversion error.

fn try_from(i: &'a MessageItem) -> Result<u8, ()>

Performs the conversion.

impl StructuralPartialEq for MessageItem