Struct zbus::MatchRule

pub struct MatchRule<'m> { /* private fields */ }

A bus match rule for subscribing to specific messages.

This is mainly used by peer to subscribe to specific signals as by default the bus will not send out most broadcasted signals. This API is intended to make it easy to create and parse match rules. See the match rules section of the D-Bus specification for a description of each possible element of a match rule.

Examples

use std::convert::TryFrom;
let rule = MatchRule::builder()
    .msg_type(zbus::MessageType::Signal)
    .sender("org.freedesktop.DBus")?
    .interface("org.freedesktop.DBus.Properties")?
    .member("PropertiesChanged")?
    .build();
let rule_str = rule.to_string();
assert_eq!(
    rule_str,
    "type='signal',sender='org.freedesktop.DBus',interface='org.freedesktop.DBus.Properties',member='PropertiesChanged'",
);

// Let's parse it back.
let parsed_rule = MatchRule::try_from(rule_str.as_str())?;
assert_eq!(rule, parsed_rule);

Caveats

The PartialEq implementation assumes arguments in both rules are in the same order.

Implementations

impl<'m> MatchRule<'m>

pub fn builder() -> MatchRuleBuilder<'m>

Create a builder for MatchRuleBuilder.

pub fn sender(&self) -> Option<&BusName<'_>>

The sender, if set.

pub fn msg_type(&self) -> Option<MessageType>

The message type, if set.

pub fn interface(&self) -> Option<&InterfaceName<'_>>

The interfac, if set.

pub fn member(&self) -> Option<&MemberName<'_>>

The member name if set.

pub fn path_spec(&self) -> Option<&MatchRulePathSpec<'_>>

The path or path namespace, if set.

pub fn destination(&self) -> Option<&UniqueName<'_>>

The destination, if set.

pub fn args(&self) -> &[Str<'_>]

The arguments.

pub fn arg_paths(&self) -> &[ObjectPath<'_>]

The argument paths.

pub fn arg0namespace(&self) -> Option<&InterfaceName<'_>>

Match messages whose first argument is within the specified namespace.

Note that while the spec allows this to be any string that’s a valid bus or interface name except that it can have no ., we only allow valid interface names. The reason is not only to keep things simple and type safe at the same time but also for the fact that use cases of only matching on the first component of a bus or interface name are unheard of.

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

Creates an owned clone of self.

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

Creates an owned clone of self.

Trait Implementations

impl<'m> Clone for MatchRule<'m>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'m> Debug for MatchRule<'m>

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

Formats the value using the given formatter.

impl<'de: 'm, 'm> Deserialize<'de> for MatchRule<'m>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'unowned, 'owned: 'unowned> From<&'owned OwnedMatchRule> for MatchRule<'unowned>

fn from(rule: &'owned OwnedMatchRule) -> Self

Converts to this type from the input type.

impl From<MatchRule<'_>> for OwnedMatchRule

fn from(rule: MatchRule<'_>) -> Self

Converts to this type from the input type.

impl From<OwnedMatchRule> for MatchRule<'static>

fn from(o: OwnedMatchRule) -> Self

Converts to this type from the input type.

impl<'m> Hash for MatchRule<'m>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<MatchRule<'_>> for OwnedMatchRule

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'m> PartialEq<MatchRule<'m>> for MatchRule<'m>

fn eq(&self, other: &MatchRule<'m>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MatchRule<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl ToString for MatchRule<'_>

fn to_string(&self) -> String

Converts the given value to a String.

impl<'m> TryFrom<&'m str> for MatchRule<'m>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'m str) -> Result<Self>

Performs the conversion.

impl<'m> Type for MatchRule<'m>

fn signature() -> Signature<'static>

Get the signature for the implementing type.

impl<'m> Eq for MatchRule<'m>

impl<'m> StructuralEq for MatchRule<'m>

impl<'m> StructuralPartialEq for MatchRule<'m>