Struct zenoh::PathExpr

pub struct PathExpr { /* fields omitted */ }

A zenoh Path Expression used to express a selection of Paths.

Similarly to a Path, a Path is a set of strings separated by '/' , as in a filesystem path. But unlike a Path it can contain '*' characters:

• a single '*' character matches any set of characters in a path, except '/'.
• while "**" matches any set of characters in a path, including '/'.

A Path Expression can be absolute (i.e. starting with a '/') or relative to a Workspace.

Implementations

impl PathExpr

pub fn new(p: String) -> ZResult<PathExpr>

Creates a new PathExpr from a String, checking its validity.
Returns Err(ZError) if not valid.

pub fn as_str(&self) -> &str

Returns the Path as a &str.

pub fn is_relative(&self) -> bool

Returns true is this PathExpr is relative (i.e. not starting with '/').

pub fn is_a_path(&self) -> bool

Returns true is this PathExpr is a Path (i.e. not containing any '*').

pub fn with_prefix(&self, prefix: &Path) -> Self

Returns the concatenation of prefix with this PathExpr.

pub fn strip_prefix(&self, prefix: &Path) -> Option<Self>

If this PathExpr starts with prefix returns a copy of this PathExpr with the prefix removed.
Otherwise, returns None.

pub fn matches(&self, path: &Path) -> bool

Returns true if path matches this PathExpr.

Trait Implementations

impl Clone for PathExpr

fn clone(&self) -> PathExpr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathExpr

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

Formats the value using the given formatter.

impl Display for PathExpr

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

Formats the value using the given formatter.

impl Eq for PathExpr

impl<'_> From<&'_ Path> for PathExpr

fn from(path: &Path) -> Self

Performs the conversion.

impl<'_> From<&'_ PathExpr> for ResKey

fn from(path: &PathExpr) -> Self

Performs the conversion.

impl From<Path> for PathExpr

fn from(path: Path) -> Self

Performs the conversion.

impl From<PathExpr> for ResKey

fn from(path: PathExpr) -> Self

Performs the conversion.

impl Hash for PathExpr

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<PathExpr> for PathExpr

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for PathExpr

impl StructuralPartialEq for PathExpr

impl<'_> TryFrom<&'_ str> for PathExpr

type Error = ZError

The type returned in the event of a conversion error.

fn try_from(p: &str) -> ZResult<PathExpr>

Performs the conversion.

impl TryFrom<String> for PathExpr

type Error = ZError

The type returned in the event of a conversion error.

fn try_from(p: String) -> Result<Self, Self::Error>

Performs the conversion.