Struct dbus_message_parser::Message

pub struct Message { /* fields omitted */ }

This represents a DBus message.

Methods

impl Message

pub fn decode(
    buf: &BytesMut,
    offset: &mut usize
) -> Result<Message, DecodeError>

Decode a byte array to a Message object.

Example

let msg = b"l\x02\x01\x01\n\0\0\0\x01\0\0\0=\0\0\0\x06\x01s\0\x05\0\0\0:1.98\0\0\0\x05\x01u\0\x01\0\0\0\x08\x01g\0\x01s\0\0\x07\x01s\0\x14\0\0\0org.freedesktop.DBus\0\0\0\0\x05\0\0\0:1.98\0";
let buf_read = BytesMut::from(&msg[..]);
let mut offset: usize = 0;

if let Ok(msg) = Message::decode(&buf_read, &mut offset) {
    //...
}

pub fn encode(&self, buf: &mut BytesMut) -> Result<(), EncodeError>

Encode a Message object to a byte array.

pub fn method_call(
    destination: &str,
    path: &str,
    interface: &str,
    member: &str
) -> Message

Create a Message object as a MethodCall.

pub fn signal(path: &str, interface: &str, member: &str) -> Message

Create a Message object as a Signal.

pub 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<&String>

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<&String>

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

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<&String>

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<&String>

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

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

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

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

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

pub fn has_signature(&self) -> bool

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

pub fn get_signature(&self) -> Option<&String>

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

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

Add a new value to the body.

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

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

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

Create a unknown path error message from this Message.

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

Create a unknown interface error message from this Message.

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

Create a unknown method error message from this Message.

pub fn invalid_args(&self, reason: &str) -> Result<Message, ()>

Create an invalid args error message from this Message.

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

Create an error message from this Message.

pub fn get_body(&self) -> &Vec<Value>

Get the body.

pub fn get_type(&self) -> MessageType

Get the message type.

pub fn split(self) -> (MessageHeader, Vec<Value>)

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.