Struct Relative 

pub struct Relative<'a>(/* private fields */);

A relative broadcast path, used to reference one broadcast from another broadcast’s content.

Unlike Path (which is a complete reference within the broadcast namespace), Relative may contain . and .. segments to walk the namespace and is meaningful only when resolved against a base Path via Path::resolve. The hang catalog uses it to point a rendition at a track published in a sibling broadcast (e.g. ./source).

Relative has no Encode/Decode impl, so it never appears in announce/subscribe frames. It does serialize via serde for off-wire use (e.g. as a field inside a catalog JSON payload, which itself travels as a track).

Normalization on creation: leading/trailing slashes are trimmed, consecutive internal slashes collapse to one, and redundant . segments are stripped. A reference made only of . segments normalizes to . rather than empty because . resolves to the base’s parent while empty resolves to the base itself. .. is preserved for resolve time.

Examples

use moq_net::{Path, path::Relative};

let rel = Relative::new("./source");
assert_eq!(Path::new("a/b").resolve(&rel).as_str(), "a/source");

// Redundant `.` segments are stripped on creation.
assert_eq!(Relative::new("./a/./b").as_str(), "a/b");
assert_eq!(Relative::new(".").as_str(), ".");

Implementations

impl<'a> Relative<'a>

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

Create a new Relative from a string slice.

Leading and trailing slashes are trimmed, consecutive internal slashes collapse to one, and redundant . segments are stripped. See the type-level doc for the full rules.

pub fn as_str(&self) -> &str

The normalized path as a string slice.

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

The empty relative path, which resolves to the base path itself.

pub fn is_empty(&self) -> bool

True if the path is empty (resolves to the base path itself).

pub fn len(&self) -> usize

The length of the normalized path in bytes.

pub fn to_owned(&self) -> RelativeOwned

Copy into an owned version with a 'static lifetime.

pub fn into_owned(self) -> RelativeOwned

Convert into an owned version with a 'static lifetime.

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

Reborrow without copying.

Trait Implementations

impl AsRef<str> for Relative<'_>

fn as_ref(&self) -> &str

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

impl<'a> Clone for Relative<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Relative<'a>

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

Formats the value using the given formatter.

impl Default for Relative<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Relative<'static>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Relative<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for Relative<'a>

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for Relative<'_>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a> Hash for Relative<'a>

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<'a> PartialEq for Relative<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> Serialize for Relative<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Relative<'a>