Struct PathBuf

pub struct PathBuf<'a> { /* private fields */ }

A path buffer that can be used to build paths.

The difference between a PathBuf and a Path is that a PathBuf is mutable and can be modified, while a Path is immutable and is joined into one but knows how to split it into parts.

Example

use postcard_bindgen_core::path::PathBuf;

let mut path = PathBuf::new();

assert!(path.is_empty());

path.push("foo");
path.push("bar");
path.push("baz");

assert!(!path.is_empty());
assert_eq!(path.parts().map(|p| p.as_ref()).collect::<Vec<&str>>(), vec!["foo", "bar", "baz"]);

Implementations

impl<'a> PathBuf<'a>

pub fn new() -> Self

Create a new empty path buffer.

pub fn join(self, joiner: impl Into<Part<'a>>) -> Self

Join a part into the path buffer by consuming the PathBuf.

This allows to chain calls to join parts into the path buffer.

Example

use postcard_bindgen_core::path::PathBuf;

let path = PathBuf::new().join("foo").join("bar").join("baz");

assert_eq!(path.parts().map(|p| p.as_ref()).collect::<Vec<&str>>(), vec!["foo", "bar", "baz"]);

pub fn push(&mut self, part: impl Into<Part<'a>>)

Push a part to the end of the path buffer.

pub fn push_front(&mut self, part: impl Into<Part<'a>>)

Push a part to the front of the path buffer.

pub fn pop_front(&mut self)

Pop a part from the end of the path buffer.

pub fn parts(&self) -> impl Iterator<Item = &Part<'a>>

Gives an iterator over the parts of the path buffer.

pub fn is_empty(&self) -> bool

Check if the path buffer is empty.

pub fn into_path<'b>(self, joiner: impl Into<Part<'b>>) -> Path<'a, 'b>

Convert the path buffer into a Path by consuming the path buffer.

pub fn flatten(&mut self)

Flatten the path to the root by simply removing all parts.

pub fn into_owned(self) -> PathBuf<'static>

Convert the path buffer into an owned path buffer by consuming the path buffer.

Trait Implementations

impl<'a> Clone for PathBuf<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PathBuf<'a>

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

Formats the value using the given formatter.

impl Default for PathBuf<'_>

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<'a> FromIterator<Cow<'a, str>> for PathBuf<'a>

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = Part<'a>>,

Creates a value from an iterator.

impl<'a> Hash for PathBuf<'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> Ord for PathBuf<'a>

fn cmp(&self, other: &PathBuf<'a>) -> 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<'a> PartialEq for PathBuf<'a>

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

fn partial_cmp(&self, other: &PathBuf<'a>) -> 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<'a> Eq for PathBuf<'a>

impl<'a> StructuralPartialEq for PathBuf<'a>