Struct SignalEmitter

pub struct SignalEmitter<'s> {
    conn: Connection,
    path: ObjectPath<'s>,
    destination: Option<BusName<'s>>,
}

A signal emitter.

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

See crate::object_server::InterfaceRef::signal_emitter and crate::interface documentation for details and examples of this type in use.

Fields

conn: Connection

path: ObjectPath<'s>

destination: Option<BusName<'s>>

Implementations

impl<'s> SignalEmitter<'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 async fn emit<'i, 'm, I, M, B>( &self, interface: I, signal_name: M, body: &B, ) -> Result<()>

where I: TryInto<InterfaceName<'i>>, I::Error: Into<Error>, M: TryInto<MemberName<'m>>, M::Error: Into<Error>, B: Serialize + DynamicType,

Emit a signal on the given interface with the given signal name and body.

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) -> SignalEmitter<'static>

Create an owned clone of self.

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

Convert into an owned clone of self.

Trait Implementations

impl<'s> Clone for SignalEmitter<'s>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for SignalEmitter<'s>

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

Formats the value using the given formatter.

impl ObjectManagerSignals for SignalEmitter<'_>

fn interfaces_added<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, object_path: ObjectPath<'life1>, interfaces_and_properties: HashMap<InterfaceName<'life2>, HashMap<&'life3 str, Value<'life4>>>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

This signal is emitted when either a new object is added or when an existing object gains one or more interfaces. The interfaces_and_properties argument contains a map with the interfaces and properties (if any) that have been added to the given object path.

fn interfaces_removed<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, object_path: ObjectPath<'life1>, interfaces: Cow<'life2, [InterfaceName<'life3>]>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

This signal is emitted whenever an object is removed or it loses one or more interfaces. The interfaces parameters contains a list of the interfaces that were removed.

impl PropertiesSignals for SignalEmitter<'_>

fn properties_changed<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'async_trait>( &'life0 self, interface_name: InterfaceName<'life1>, changed_properties: HashMap<&'life2 str, Value<'life3>>, invalidated_properties: Cow<'life4, [&'life5 str]>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait,

Emit the org.freedesktop.DBus.Properties.PropertiesChanged signal.