Struct RouteKey

pub struct RouteKey {
    pub topic: String,
    pub type_hint: Option<String>,
}

Topic plus an optional type hint.

topic is the only required coordinate. type_hint is whatever discriminator the publishing adapter has: an OWP message name, a UCI type, a PDU type. A subscription with type_hint: None matches every type on that topic. A publish with no hint reaches wildcards only.

Neither field is validated. Matching is exact string equality, not a hierarchy, even though Display looks like a path.

Fields

topic: String

Engine topic. Often a UCI message name when bridging ActiveMQ.

type_hint: Option<String>

Protocol discriminator. None is a wildcard subscription, or an untyped publish.

Implementations

impl RouteKey

pub fn topic(topic: impl Into<String>) -> Self

A wildcard: every type on topic.

pub fn typed(topic: impl Into<String>, type_hint: impl Into<String>) -> Self

One type on topic. A publish with this hint also reaches Self::topic subscribers on the same topic.

pub fn is_wildcard(&self) -> bool

Whether this key has no type hint.

True for both a wildcard subscription and an untyped publish. Those two roles match different sets; this predicate does not distinguish them.

Trait Implementations

impl Clone for RouteKey

fn clone(&self) -> RouteKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteKey

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

Formats the value using the given formatter.

impl Display for RouteKey

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

Formats as topic/hint, or topic/ when there is no hint.

Trailing slashes on topic are stripped only in the wildcard form, so demo/ and demo display the same when untyped.

impl Hash for RouteKey

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 for RouteKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RouteKey

impl StructuralPartialEq for RouteKey