Struct Message

pub struct Message<'a> { /* private fields */ }

A borrowed D-Bus message.

This is the borrowed variant of MessageBuf, to convert to an MessageBuf, use Message::to_owned.

Implementations

impl<'a> Message<'a>

pub fn method_call( path: &'a ObjectPath, member: &'a str, serial: NonZeroU32, ) -> Self

Construct a method call Message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
let m2 = Message::method_call(PATH, "Hello", m.serial());
assert_eq!(m, m2);

pub fn method_return(&self, serial: NonZeroU32) -> Self

Convert this message into a MessageKind::MethodReturn message with an empty body where the reply serial matches that of the current message.

The send argument is used to populate the next serial number.

Examples

use tokio_dbus::{Message, MessageKind, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello")
    .with_sender("se.tedro.DBusExample")
    .with_destination("org.freedesktop.DBus");

let m2 = m.method_return(send.next_serial());
assert!(matches!(m2.kind(), MessageKind::MethodReturn { .. }));

assert_eq!(m.sender(), m2.destination());
assert_eq!(m.destination(), m2.sender());

pub fn signal(member: &'a str, serial: NonZeroU32) -> Self

Construct a signal Message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.signal("Hello");
let m2 = Message::signal("Hello", m.serial());
assert_eq!(m, m2);

pub fn error(&self, error_name: &'a str, serial: NonZeroU32) -> Self

Convert this message into a MessageKind::Error message with an empty body where the reply serial matches that of the current message.

Examples

use tokio_dbus::{Message, MessageKind, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello")
    .with_sender("se.tedro.DBusExample")
    .with_destination("org.freedesktop.DBus");

let m2 = m.error("org.freedesktop.DBus.UnknownMethod", send.next_serial());
assert!(matches!(m2.kind(), MessageKind::Error { .. }));

assert_eq!(m.sender(), m2.destination());
assert_eq!(m.destination(), m2.sender());

pub fn to_owned(&self) -> MessageBuf

Convert into an owned MessageBuf.

Examples

use tokio_dbus::{Message, MessageBuf, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello").to_owned();
let m2 = MessageBuf::method_call(PATH.into(), "Hello".into(), m.serial());
assert_eq!(m, m2);

pub fn kind(&self) -> MessageKind<'a>

Get the kind of the message.

Examples

use tokio_dbus::{Message, MessageKind, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));

let m2 = m.error("org.freedesktop.DBus.UnknownMethod", send.next_serial());
assert!(matches!(m2.kind(), MessageKind::Error { .. }));

pub fn with_body(self, body: impl AsBody<'a>) -> Self

Modify the body and signature of the message to match that of the provided body buffer.

Examples

use tokio_dbus::{BodyBuf, MessageKind, ObjectPath, SendBuf, Signature};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();
let mut body = BodyBuf::new();

body.store("Hello World!");

let m = send.method_call(PATH, "Hello")
    .with_body(&body);

assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));
assert_eq!(m.signature(), Signature::STRING);

pub fn body(&self) -> Body<'a>

Get a buffer to the body of the message.

Examples

use tokio_dbus::{BodyBuf, MessageKind, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();
let mut body = BodyBuf::new();

body.store(42u32);
body.store("Hello World!");

let m = send.method_call(PATH, "Hello")
    .with_body(&body);

assert!(matches!(m.kind(), MessageKind::MethodCall { .. }));
assert_eq!(m.signature(), "us");

let mut r = m.body();
assert_eq!(r.load::<u32>()?, 42);
assert_eq!(r.read::<str>()?, "Hello World!");

pub fn serial(&self) -> NonZeroU32

Get the serial of the message.

Examples

use std::num::NonZeroU32;

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.serial().get(), 1);

let m2 = m.with_serial(NonZeroU32::new(1000).unwrap());
assert_eq!(m2.serial().get(), 1000);

pub fn with_serial(self, serial: NonZeroU32) -> Self

Modify the serial of the message.

Examples

use std::num::NonZeroU32;

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.serial().get(), 1);

let m2 = m.with_serial(NonZeroU32::new(1000).unwrap());
assert_eq!(m2.serial().get(), 1000);

pub fn flags(&self) -> Flags

Get the flags of the message.

Examples

use tokio_dbus::{Flags, Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.flags(), Flags::default());

let m2 = m.with_flags(Flags::NO_REPLY_EXPECTED);
assert_eq!(m2.flags(), Flags::NO_REPLY_EXPECTED);

pub fn with_flags(self, flags: Flags) -> Self

Modify the flags of the message.

Examples

use tokio_dbus::{Flags, Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.flags(), Flags::default());

let m2 = m.with_flags(Flags::NO_REPLY_EXPECTED);
assert_eq!(m2.flags(), Flags::NO_REPLY_EXPECTED);

pub fn interface(&self) -> Option<&'a str>

Get the interface of the message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.interface(), None);

let m2 = m.with_interface("org.freedesktop.DBus");
assert_eq!(m2.interface(), Some("org.freedesktop.DBus"));

pub fn with_interface(self, interface: &'a str) -> Self

Modify the interface of the message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.interface(), None);

let m2 = m.with_interface("org.freedesktop.DBus");
assert_eq!(m2.interface(), Some("org.freedesktop.DBus"));

pub fn destination(&self) -> Option<&'a str>

Get the destination of the message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.destination(), None);

let m2 = m.with_destination(":1.131");
assert_eq!(m2.destination(), Some(":1.131"));

pub fn with_destination(self, destination: &'a str) -> Self

Modify the destination of the message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.destination(), None);

let m2 = m.with_destination(":1.131");
assert_eq!(m2.destination(), Some(":1.131"));

pub fn sender(&self) -> Option<&'a str>

Get the sender of the message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.destination(), None);

let m2 = m.with_sender(":1.131");
assert_eq!(m2.sender(), Some(":1.131"));

pub fn with_sender(self, sender: &'a str) -> Self

Modify the sender of the message.

Examples

use tokio_dbus::{Message, ObjectPath, SendBuf};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.destination(), None);

let m2 = m.with_sender(":1.131");
assert_eq!(m2.sender(), Some(":1.131"));

pub fn signature(&self) -> &Signature

Get the signature of the message.

Examples

use tokio_dbus::{BodyBuf, ObjectPath, SendBuf, Signature};

const PATH: &ObjectPath = ObjectPath::new_const(b"/org/freedesktop/DBus");

let mut send = SendBuf::new();

let m = send.method_call(PATH, "Hello");
assert_eq!(m.signature(), Signature::EMPTY);

let mut body = BodyBuf::new();
body.store("Hello World!");

let m2 = m.with_body(&body);
assert_eq!(m2.signature(), Signature::STRING);

Trait Implementations

impl<'a> Clone for Message<'a>

fn clone(&self) -> Message<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Message<'a>

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

Formats the value using the given formatter.

impl PartialEq<Message<'_>> for MessageBuf

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<MessageBuf> for Message<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq for Message<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Message<'a>

impl<'a> StructuralPartialEq for Message<'a>