Struct dbus::message::MatchRule

pub struct MatchRule<'a> {
    pub msg_type: Option<MessageType>,
    pub sender: Option<BusName<'a>>,
    pub strict_sender: bool,
    pub path: Option<Path<'a>>,
    pub path_is_namespace: bool,
    pub interface: Option<Interface<'a>>,
    pub member: Option<Member<'a>>,
    pub eavesdrop: bool,
    /* private fields */
}

A “match rule”, that can match Messages on its headers.

A field set to “None” means no filter for that header, a field set to “Some(_)” must match exactly.

Fields

msg_type: Option<MessageType>

Match on message type (you typically want to do this)

sender: Option<BusName<'a>>

Match on message sender

strict_sender: bool

If false (the default), match if sender could possibly match, due to mismatch between unique names and taken bus names

path: Option<Path<'a>>

Match on message object path

path_is_namespace: bool

If true, will match all subpaths to the path as well as the path itself. Defaults to false.

interface: Option<Interface<'a>>

Match on message interface

member: Option<Member<'a>>

Match on message member (signal or method name)

eavesdrop: bool

If true, also receive messages not intended for us. Defaults to false.

Implementations

impl<'a> MatchRule<'a>

pub fn match_str(&self) -> String

Make a string which you can use in the call to “add_match”.

pub fn matches(&self, msg: &Message) -> bool

Returns whether or not the message matches the rule.

pub fn new() -> Self

Create a new struct which matches every message.

pub fn new_method_call() -> Self

Create a new struct which matches every incoming method call message.

pub fn new_signal<I: Into<Interface<'a>>, N: Into<Member<'a>>>(
    intf: I,
    name: N
) -> Self

Create a new struct which matches signals on the interface and member name.

pub fn static_clone(&self) -> MatchRule<'static>

Returns a clone with no borrowed references

pub fn with_eavesdrop(self) -> Self

Enables eavesdropping for the generated message. You probably want to use BecomeMonitor instead

pub fn with_sender(self, sender: impl Into<BusName<'a>>) -> Self

Sets the MatchRule to match on the message sender

pub fn with_strict_sender(self, sender: impl Into<BusName<'a>>) -> Self

Sets the MatchRule to match on the message sender and be strict

pub fn with_namespaced_path(self, path: impl Into<Path<'a>>) -> Self

Sets the MatchRule to match on the message path and treat it as a namespace

pub fn with_path(self, path: impl Into<Path<'a>>) -> Self

Sets the MatchRule to match on the message path

pub fn with_interface(self, intf: impl Into<Interface<'a>>) -> Self

Sets the MatchRule to match on the message interface

pub fn with_member(self, member: impl Into<Member<'a>>) -> Self

Sets the MatchRule to match on the message member

pub fn with_type(self, ty: MessageType) -> Self

Sets the MatchRule to match on the message type. This will usually be "signal"

pub fn parse(text: &'a str) -> Result<Self, Error>

Tries parsing a MatchRule from a String. Please note however that not all features supported by DBus are supported by dbus-rs (yet). args and destinations are not supported yet.

Trait Implementations

impl<'a> Clone for MatchRule<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MatchRule<'a>

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

Formats the value using the given formatter.

impl<'a> Default for MatchRule<'a>

fn default() -> MatchRule<'a>

Returns the “default value” for a type.