Skip to main content

Path

Struct Path 

Source
pub struct Path<'a>(/* private fields */);
Expand description

A broadcast path that provides safe prefix matching operations.

This type wraps a string but provides path-aware operations that respect delimiter boundaries, preventing issues like “foo” matching “foobar”.

Paths are automatically trimmed of leading and trailing slashes on creation, making all slashes implicit at boundaries. All paths are RELATIVE; you cannot join with a leading slash to make an absolute path.

Owned paths (PathOwned) share one reference-counted allocation: cloning, converting a shared path with Path::to_owned, and suffix operations like Path::strip_prefix do not copy the underlying bytes.

§Examples

use moq_net::{Path};

// Creation automatically trims slashes
let path1 = Path::new("/foo/bar/");
let path2 = Path::new("foo/bar");
assert_eq!(path1, path2);

// Methods accept both &str and Path
let base = Path::new("api/v1");
assert!(base.has_prefix("api"));
assert!(base.has_prefix(&Path::new("api/v1")));

let joined = base.join("users");
assert_eq!(joined.as_str(), "api/v1/users");

Implementations§

Source§

impl<'a> Path<'a>

Source

pub const MAX_PARTS: usize = 32

Maximum number of slash-separated parts in a path.

Matches the IETF moq-transport limit of 32 fields in a namespace tuple. moq-lite enforces the same bound: encoding or decoding a deeper path fails, and publishing one to an origin is rejected.

Source

pub fn new(s: &'a str) -> Self

Create a new Path from a string slice.

Leading and trailing slashes are automatically trimmed. Multiple consecutive internal slashes are collapsed to single slashes.

Source

pub fn has_prefix(&self, prefix: impl AsPath) -> bool

Check if this path has the given prefix, respecting path boundaries.

Unlike String::starts_with, this ensures that “foo” does not match “foobar”. The prefix must either:

  • Be exactly equal to this path
  • Be followed by a ‘/’ delimiter in the original path
  • Be empty (matches everything)
§Examples
use moq_net::Path;

let path = Path::new("foo/bar");
assert!(path.has_prefix("foo"));
assert!(path.has_prefix(&Path::new("foo")));
assert!(path.has_prefix("foo/"));
assert!(!path.has_prefix("fo"));

let path = Path::new("foobar");
assert!(!path.has_prefix("foo"));
Source

pub fn strip_prefix(&'a self, prefix: impl AsPath) -> Option<Path<'a>>

Source

pub fn parts(&self) -> impl Iterator<Item = &str>

Iterate over the slash-separated parts of the path.

The empty path has no parts.

§Examples
use moq_net::Path;

let path = Path::new("foo/bar/baz");
assert_eq!(path.parts().collect::<Vec<_>>(), ["foo", "bar", "baz"]);
assert_eq!(Path::empty().parts().count(), 0);
Source

pub fn next_part(&'a self) -> Option<(&'a str, Path<'a>)>

Strip the directory component of the path, if any, and return the rest of the path.

Source

pub fn as_str(&self) -> &str

Source

pub fn empty() -> Path<'static>

Source

pub fn is_empty(&self) -> bool

Source

pub fn len(&self) -> usize

Source

pub fn to_owned(&self) -> PathOwned

Source

pub fn into_owned(self) -> PathOwned

Source

pub fn borrow(&'a self) -> Path<'a>

A copy of this path bound to self’s lifetime, without copying the underlying bytes.

Source

pub fn join(&self, other: impl AsPath) -> PathOwned

Join this path with another path component.

§Examples
use moq_net::Path;

let base = Path::new("foo");
let joined = base.join("bar");
assert_eq!(joined.as_str(), "foo/bar");

let joined = base.join(&Path::new("bar"));
assert_eq!(joined.as_str(), "foo/bar");

Trait Implementations§

Source§

impl<'a> AsPath for &'a Path<'a>

Source§

fn as_path(&self) -> Path<'a>

Source§

impl AsPath for Path<'_>

Source§

fn as_path(&self) -> Path<'_>

Source§

impl AsRef<str> for Path<'_>

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<'a> Clone for Path<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Path<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Path<'_>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Path<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Path<'_>

Source§

impl<'a> From<&'a String> for Path<'a>

Source§

fn from(s: &'a String) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<&'a str> for Path<'a>

Source§

fn from(s: &'a str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Path<'_>

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<Path<'static>> for PathPrefixes

Source§

fn from_iter<I: IntoIterator<Item = PathOwned>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl Hash for Path<'_>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Path<'_>

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<'b> PartialEq<Path<'b>> for Path<'_>

Source§

fn eq(&self, other: &Path<'b>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Path<'_>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Path<'a>

§

impl<'a> RefUnwindSafe for Path<'a>

§

impl<'a> Send for Path<'a>

§

impl<'a> Sync for Path<'a>

§

impl<'a> Unpin for Path<'a>

§

impl<'a> UnsafeUnpin for Path<'a>

§

impl<'a> UnwindSafe for Path<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more