Struct dbus_message_parser::message::Message

pub struct Message { /* fields omitted */ }

This represents a DBus message.

Implementations

impl Message

pub fn decode(bytes: Bytes) -> DecodeResult<(Message, usize)>

The decode a Message and returns the offset.

pub fn decode_with_fds(
    bytes: Bytes,
    fds: &[RawFd]
) -> DecodeResult<(Message, usize, usize)>

The decode a Message and returns the offset and the offset of the given FDs.

impl Message

pub fn encode(&self) -> EncodeResult<BytesMut>

pub fn encode_with_fds(&self) -> EncodeResult<(BytesMut, Vec<RawFd>)>

impl Message

pub fn new(header: Header, body: Vec<Value>) -> Message

Create a Message object.

pub fn method_call(
    destination: Bus,
    object_path: ObjectPath,
    interface: Interface,
    member: Member
) -> Message

Create a Message object as a MethodCall.

pub fn signal(
    object_path: ObjectPath,
    interface: Interface,
    member: Member
) -> Message

Create a Message object as a Signal.

pub fn property_get(
    destination: Bus,
    object_path: ObjectPath,
    interface: Interface,
    property: &str
) -> Message

Create a Message to retrieve property value.

pub fn properties_get_all(
    destination: Bus,
    object_path: ObjectPath,
    interface: Interface
) -> Message

Create a Message to retrieve property value.

pub fn property_set(
    destination: Bus,
    object_path: ObjectPath,
    interface: Interface,
    property: &str,
    value: Value
) -> Message

Create a Message to retrieve property value.

pub const fn get_serial(&self) -> u32

Get the serial number.

pub fn set_serial(&mut self, serial: u32)

Set the serial number.

pub fn get_reply_serial(&self) -> Option<u32>

Get the ReplySerial number, if there is one in the header field.

pub fn get_path(&self) -> Option<&ObjectPath>

Get the Path, if there is one in the header field.

pub fn has_interface(&self) -> bool

It is true if the message contains an Interface in the header fields.

pub fn get_interface(&self) -> Option<&Interface>

Get the Interface, if there is one in the header fields.

pub fn has_member(&self) -> bool

It is true if the message contains an Member in the header fields.

pub fn get_member(&self) -> Option<&Member>

Get the Member, if there is one in the header field.

pub fn has_error_name(&self) -> bool

It is true if the message contains an ErrorName in the header fields.

pub fn get_error_name(&self) -> Option<&Error>

Get the ErrorName, if there is one in the header field.

pub fn get_sender(&self) -> Option<&Bus>

Get the Sender, if there is one in the header field.

pub fn get_destination(&self) -> Option<&Bus>

Get the Destination, if there is one in the header field.

pub fn get_signature(&self) -> Result<Vec<Type>, TypeError>

Get the Signature, if there is one in the header field.

pub fn get_unix_fds(&self) -> Option<u32>

Get the UnixFDs, if there is one in the header field.

pub fn has_unix_fds(&self) -> bool

It is true if the message contains an UnixFDs in the header fields.

pub fn add_value(&mut self, value: Value)

Add a new value to the body.

pub fn method_return(&self) -> Result<Message, Message>

Create a message return from this Message. Only works if this Message is a MethodCall.

pub fn unknown_property(&self, property: &str) -> Message

Create a unknown property error message from this Message.

pub fn unknown_path(&self) -> Option<Message>

Create a unknown path error message from this Message.

pub fn unknown_interface(&self) -> Option<Message>

Create a unknown interface error message from this Message.

pub fn unknown_member(&self) -> Option<Message>

Create a unknown member error message from this Message.

pub fn invalid_args(&self, reason: String) -> Message

Create an invalid args error message from this Message.

pub fn error(&self, name: Error, message: String) -> Message

Create an error message from this Message.

pub fn get_body(&self) -> &[Value]

Get the body.

pub fn get_type(&self) -> MessageType

Get the message type.

pub fn split(self) -> Result<(Header, Vec<Value>), TypeError>

Split the Message object into the header and the body.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl PartialEq<Message> for Message

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

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

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

This method tests for !=.

impl PartialOrd<Message> for Message

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