Struct Path

pub struct Path(/* private fields */);

A path type used throughout Component Framework, along with its variants NamespacePath and RelativePath. Examples of use:

• NamespacePath: Namespace paths
• Path: Outgoing paths and namespace paths that can’t be “/”
• RelativePath: Dictionary paths

Path obeys the following constraints:

• Is a fuchsia.io.Path.
• Begins with /.
• Is not ..
• Contains at least one path segment (just / is disallowed).
• Each path segment is a Name. (This is strictly more constrained than a fuchsia.io path segment.)

Implementations

impl Path

pub fn new(path: impl AsRef<str>) -> Result<Self, ParseError>

Creates a Path from a String, returning an Err if the string fails validation. The string must be non-empty, no more than MAX_PATH_LENGTH bytes in length, start with a leading /, not be exactly / or ., and each segment must be a valid Name. As a result, Paths are always valid NamespacePaths.

pub fn split(&self) -> Vec<Name>

Splits the path according to “/”.

pub fn to_path_buf(&self) -> PathBuf

pub fn parent(&self) -> NamespacePath

Returns a path that represents the parent directory of this one. Returns NamespacePath instead of Path because the parent could be the root dir.

pub fn basename(&self) -> &Name

pub fn extend(&mut self, other: RelativePath)

pub fn push(&mut self, other: Name)

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Path

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Path

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

Formats the value using the given formatter.

impl From<Path> for CString

fn from(path: Path) -> Self

Converts to this type from the input type.

impl From<Path> for NamespacePath

fn from(value: Path) -> Self

Converts to this type from the input type.

impl From<Path> for String

fn from(path: Path) -> String

Converts to this type from the input type.

impl FromStr for Path

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(path: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Path

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 IterablePath for Path

fn iter_segments(&self) -> impl DoubleEndedIterator<Item = &Name> + Send

Returns a double-sided iterator over the segments in this path.

impl Ord for Path

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Path

fn eq(&self, other: &Path) -> 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 PartialOrd for Path

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Path

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CString> for Path

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(path: CString) -> Result<Self, ParseError>

Performs the conversion.

impl Eq for Path

impl StructuralPartialEq for Path