Struct zbus::SignalContext

pub struct SignalContext<'s> { /* private fields */ }

A signal emission context.

For signal emission using the high-level API, you’ll need instances of this type.

See crate::InterfaceRef::signal_context and crate::dbus_interface documentation for details and examples of this type in use.

Implementations

impl<'s> SignalContext<'s>

pub fn new<P>(conn: &Connection, path: P) -> Result<Self>

where P: TryInto<ObjectPath<'s>>, P::Error: Into<Error>,

Create a new signal context for the given connection and object path.

pub fn from_parts(conn: Connection, path: ObjectPath<'s>) -> Self

Create a new signal context for the given connection and object path.

pub fn set_destination(self, destination: BusName<'s>) -> Self

Set the destination for the signal emission.

Signals are typically broadcasted and thus don’t have a destination. However, there are cases where you need to unicast signals to specific peers. This method allows you to set the destination for the signals emitted with this context.

pub fn connection(&self) -> &Connection

Get a reference to the associated connection.

pub fn path(&self) -> &ObjectPath<'s>

Get a reference to the associated object path.

pub fn destination(&self) -> Option<&BusName<'s>>

Get a reference to the associated destination (if any).

pub fn to_owned(&self) -> SignalContext<'static>

Creates an owned clone of self.

pub fn into_owned(self) -> SignalContext<'static>

Creates an owned clone of self.

Trait Implementations

impl<'s> Clone for SignalContext<'s>

fn clone(&self) -> SignalContext<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for SignalContext<'s>

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

Formats the value using the given formatter.