Struct async_rustbus::MatchRule

pub struct MatchRule {
    pub sender: Option<Arc<str>>,
    pub path: Option<Arc<str>>,
    pub path_namespace: Option<Arc<str>>,
    pub interface: Option<Arc<str>>,
    pub member: Option<Arc<str>>,
    // some fields omitted
}

Represents a match for incoming signals.

Signals match a MatchRule if they match every field. When one of the fields is None it is equivelent to a wildcard for that field, causing that field to be matching for every signal.

MatchRule’s are ordered by their specificity. If one MatchRule is ‘less than’ another, then it is more specific than the other one. See the Ord impl for details.

Fields

sender: Option<Arc<str>>

Checks against the sender of the signal.

path: Option<Arc<str>>

Matches against the object path of the signal requiring an exact match (no children). path and path_namespace cannot be used simultanously.

path_namespace: Option<Arc<str>>

Matches against the object path of the signal. It accepts an exact match, or a child of path_namespace. path and path_namespace cannot be used simultanously.

interface: Option<Arc<str>>

Matches against the interface of the signal.

member: Option<Arc<str>>

Matches against the signal member.

Implementations

impl MatchRule

pub fn new() -> Self

pub fn sender<S: Into<String>>(&mut self, sender: S) -> &mut Self

pub fn path<S: Into<String>>(&mut self, path: S) -> &mut Self

pub fn path_namespace<S: Into<String>>(
    &mut self,
    path_namespace: S
) -> &mut Self

pub fn interface<S: Into<String>>(&mut self, interface: S) -> &mut Self

pub fn member<S: Into<String>>(&mut self, member: S) -> &mut Self

pub fn is_empty(&self) -> bool

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

Returns true if the message is a signal and matches the rule.

pub fn match_string(&self) -> String

Returns the org.freedesktop.DBus.AddMatch match rule string.

Trait Implementations

impl Clone for MatchRule

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MatchRule

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

Formats the value using the given formatter.

impl Default for MatchRule

fn default() -> MatchRule

Returns the “default value” for a type.

impl Ord for MatchRule

MatchRules are ordered by their specificity. If one match rule is ‘less than’ another then it is more specific than the other. When evaluating specificity the following steps are taken:

1. If one rule has Some sender and the other None then, the former is less than the latter. Otherwise continue to the next step.
2. If one rule has Some path and the other None then, the former is less than the latter. Otherwise continue to the next step.
3. If one rule has Some path_namespace and the other None then, the former is less than the latter. Otherwise continue to the next step.
4. If both rules have Some path_namespace and one is a subset of the other than the former is less than the latter. Otherwise continue to the next step.
5. If one rule has Some interface and the other None then, the former is less than the latter. Otherwise continue to the next step.
6. If one rule has Some member and the other None then, the former is less than the latter. Otherwise continue to the next step.
7. Compare sender field. If not equal return the Ordering, otherwise continue to the next step.
8. Compare path field. If not equal return the Ordering, otherwise continue to the next step.
9. Compare path_namespace field. If not equal return the Ordering, otherwise continue to the next step.
10. Compare interface field. If not equal return the Ordering, otherwise continue to the next step.
11. Compare member field, and return the result.

fn cmp(&self, other: &Self) -> COrdering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<MatchRule> for MatchRule

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<MatchRule> for MatchRule

fn partial_cmp(&self, other: &MatchRule) -> Option<COrdering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for MatchRule