Struct zbus::Message

pub struct Message { /* fields omitted */ }

A D-Bus Message.

The content of the message are stored in serialized format. To deserialize the body of the message, use the body method. You may also access the header and other details with the various other getters.

Also provided are constructors for messages of different types. These will mainly be useful for very advanced use cases as typically you will want to create a message for immediate dispatch and hence use the API provided by Connection, even when using the low-level API.

Note: The message owns the received FDs and will close them when dropped. You can call disown_fds after deserializing to RawFD using body if you want to take the ownership.

Implementations

impl Message

pub fn method<B>(
    sender: Option<&str>,
    destination: Option<&str>,
    path: &str,
    iface: Option<&str>,
    method_name: &str,
    body: &B
) -> Result<Self, MessageError> where
    B: Serialize + Type, 

Create a message of type MessageType::MethodCall.

pub fn signal<B>(
    sender: Option<&str>,
    destination: Option<&str>,
    path: &str,
    iface: &str,
    signal_name: &str,
    body: &B
) -> Result<Self, MessageError> where
    B: Serialize + Type, 

Create a message of type MessageType::Signal.

pub fn method_reply<B>(
    sender: Option<&str>,
    call: &Self,
    body: &B
) -> Result<Self, MessageError> where
    B: Serialize + Type, 

Create a message of type MessageType::MethodReturn.

pub fn method_error<B>(
    sender: Option<&str>,
    call: &Self,
    name: &str,
    body: &B
) -> Result<Self, MessageError> where
    B: Serialize + Type, 

Create a message of type MessageType::MethodError.

pub fn disown_fds(&mut self)

Disown the associated file descriptors.

When a message is received over a AF_UNIX socket, it may contain associated FDs. To prevent the message from closing those FDs on drop, you may remove the ownership thanks to this method, after that you are responsible for closing them.

pub fn body_signature<'b, 's: 'b>(
    &'s self
) -> Result<Signature<'b>, MessageError>

The signature of the body.

Note: While zbus treats multiple arguments as a struct (to allow you to use the tuple syntax), D-Bus does not. Since this method gives you the signature expected on the wire by D-Bus, the trailing and leading STRUCT signature parenthesis will not be present in case of multiple arguments.

pub fn primary_header(&self) -> Result<MessagePrimaryHeader, MessageError>

Deserialize the primary header.

pub fn header<'h, 'm: 'h>(&'m self) -> Result<MessageHeader<'h>, MessageError>

Deserialize the header.

pub fn fields<'f, 'm: 'f>(&'m self) -> Result<MessageFields<'f>, MessageError>

Deserialize the fields.

pub fn body_unchecked<'d, 'm: 'd, B>(&'m self) -> Result<B, MessageError> where
    B: Deserialize<'d> + Type, 

Deserialize the body (without checking signature matching).

pub fn body<'d, 'm: 'd, B>(&'m self) -> Result<B, MessageError> where
    B: Deserialize<'d> + Type, 

Check the signature and deserialize the body.

pub fn as_bytes(&self) -> &[u8]

Get a reference to the byte encoding of the message.

Trait Implementations

impl Debug for Message

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

Formats the value using the given formatter.

impl Display for Message

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

Formats the value using the given formatter.

impl From<Message> for Error

fn from(message: Message) -> Error

Performs the conversion.

impl<S> Sink<Message> for Connection<S> where
    S: AsRawFd + Debug + Unpin + Socket,
    Async<S>: Socket, 

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, msg: Message) -> Result<()>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Flush any remaining output from this sink.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Flush any remaining output and close this sink, if necessary.