Struct TopicPatternPath 

pub struct TopicPatternPath { /* private fields */ }

Parsed MQTT topic pattern with wildcard support

Implementations

impl TopicPatternPath

pub fn new_from_string( topic_pattern: impl Into<ArcStr>, cache_strategy: CacheStrategy, ) -> Result<TopicPatternPath, TopicPatternError>

Creates a topic pattern from string with optional caching.

pub fn cache_strategy(&self) -> CacheStrategy

Get the cache strategy of this topic pattern.

pub fn parameter_bindings(&self) -> Option<&SmallVec<[(ArcStr, ArcStr); 4]>>

Returns the current parameter bindings, if any.

pub fn get_bound_value(&self, param_name: Option<&str>) -> Option<&ArcStr>

Returns the bound value for a named parameter, if it exists.

pub fn mqtt_pattern(&self) -> ArcStr

Returns MQTT pattern with wildcards for broker subscription with bound parameters applied.

pub fn resolve_bound_segments(&self) -> Vec<TopicPatternItem>

Resolves bound parameters into concrete segments

Returns segments with bound parameters replaced by their values. Unbound wildcards remain as wildcards.

pub fn topic_pattern(&self) -> ArcStr

Returns original pattern with named parameters.

pub fn is_empty(&self) -> bool

Returns true if pattern has no segments.

pub fn contains_hash(&self) -> bool

Returns true if pattern contains multi-level wildcard (#).

pub fn iter(&self) -> Iter<'_, TopicPatternItem>

Returns iterator over pattern segments.

pub fn len(&self) -> usize

Returns number of segments in pattern.

pub fn slice(&self) -> &[TopicPatternItem]

Returns pattern segments as slice.

pub fn format_topic( &self, params: &[&dyn Display], ) -> Result<String, TopicFormatError>

Formats topic by substituting wildcards with provided parameters

pub fn check_pattern_compatibility( &self, custom_topic: impl TryInto>, ) -> Result<TopicPatternPath, TopicPatternError>

where <impl TryInto<TopicPatternPath> as TryInto<TopicPatternPath>>::Error: Into<TopicPatternError>,

Checks if the provided topic pattern is compatible with this one.

Static segments can differ, but wildcards must be identical in type, order, and names (if named).

pub fn with_cache_strategy(&self, new_cache: CacheStrategy) -> TopicPatternPath

Create new pattern with different cache strategy

pub fn bind_parameter( self, param_name: impl Into<ArcStr>, value: impl Into<ArcStr>, ) -> Result<TopicPatternPath, TopicPatternError>

Add value for topic wildcard parameter

pub fn try_match( &self, topic: Arc<TopicPath>, ) -> Result<Arc<TopicMatch>, TopicMatchError>

Matches a topic against this pattern, extracting parameters.

Takes an Arc<TopicPath> so the topic can be shared cheaply: when matching ONE topic against MANY patterns (the hot path), build the Arc<TopicPath> once and pass Arc::clone(&topic) to each pattern to avoid re-parsing and re-allocating per match. For a single one-off match from a string, try_match_str is more convenient.

pub fn try_match_str( &self, topic: impl Into<ArcStr>, ) -> Result<Arc<TopicMatch>, TopicMatchError>

Convenience wrapper around try_match for one-off matches: it builds the TopicPath and wraps it in an Arc for you.

Prefer try_match on the hot path (one topic, many patterns): calling this in a loop re-parses and re-allocates the topic every time.

Trait Implementations

impl Clone for TopicPatternPath

fn clone(&self) -> TopicPatternPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopicPatternPath

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

Formats the value using the given formatter.

impl Display for TopicPatternPath

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

Formats the value using the given formatter.

impl TryFrom<&str> for TopicPatternPath

type Error = TopicPatternError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<TopicPatternPath, <TopicPatternPath as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<ArcStr> for TopicPatternPath

type Error = TopicPatternError

The type returned in the event of a conversion error.

fn try_from( value: ArcStr, ) -> Result<TopicPatternPath, <TopicPatternPath as TryFrom<ArcStr>>::Error>

Performs the conversion.

impl TryFrom<String> for TopicPatternPath

type Error = TopicPatternError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<TopicPatternPath, <TopicPatternPath as TryFrom<String>>::Error>

Performs the conversion.