Struct PathBuf 

pub struct PathBuf { /* private fields */ }

An owned, validated path for hierarchical document access.

PathBuf provides a type-safe way to construct and manipulate paths for accessing nested structures in CRDT documents. It validates that paths are well-formed and provides efficient access to path component.

Examples

// Create from string (automatically normalized)
let path = PathBuf::from_str("user.profile.name")?;

// Build incrementally (infallible)
let path = PathBuf::new()
    .push("user")
    .push("profile")
    .push("name");

// Get components
let components: Vec<&str> = path.components().collect();
assert_eq!(components, vec!["user", "profile", "name"]);

Implementations

impl PathBuf

pub fn new() -> Self

Creates a new empty path.

pub fn from_component(component: Component) -> Self

Creates a path from a single component.

pub fn push(self, path: impl AsRef<str>) -> Self

Adds a path to the end of this path.

This method accepts both strings and Path types, normalizing the input. It’s infallible and handles all path joining cases through normalization.

Examples

// Push strings
let path = PathBuf::new().push("user").push("profile");
assert_eq!(path.as_str(), "user.profile");

// Push Path types
let suffix = PathBuf::from_str("name.value").unwrap();
let path = PathBuf::new().push("user").push(&suffix);
assert_eq!(path.as_str(), "user.name.value");

pub fn push_component(self, component: Component) -> Self

Adds a validated component to the end of this path.

pub fn join(self, other: impl AsRef<Path>) -> Self

Joins this path with another path.

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

Returns an iterator over the path components as string slices.

pub fn len(&self) -> usize

Returns the number of components in the path.

pub fn is_empty(&self) -> bool

Returns true if the path has no components.

pub fn parent(&self) -> Option<PathBuf>

Returns the parent path, or None if this is the root.

pub fn file_name(&self) -> Option<&str>

Returns the last component of the path, or None if empty.

pub fn normalize(path: &str) -> Self

Creates a PathBuf by normalizing the input string.

This method always succeeds by applying path normalization rules.

Methods from Deref<Target = Path>

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

Returns an iterator over the path components as string slices.

pub fn len(&self) -> usize

Returns the number of components in the path.

pub fn is_empty(&self) -> bool

Returns true if the path has no components.

pub fn file_name(&self) -> Option<&str>

Returns the last component of the path, or None if empty.

pub fn as_str(&self) -> &str

Returns the path as a string slice.

pub fn to_path_buf(&self) -> PathBuf

Converts this Path to an owned PathBuf.

Trait Implementations

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &Path

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

impl AsRef<PathBuf> for PathBuf

fn as_ref(&self) -> &PathBuf

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

impl AsRef<str> for PathBuf

fn as_ref(&self) -> &str

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

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Clone for PathBuf

fn clone(&self) -> PathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathBuf

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 Deref for PathBuf

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for PathBuf

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

Formats the value using the given formatter.

impl From<&PathBuf> for PathBuf

fn from(path: &PathBuf) -> Self

Converts to this type from the input type.

impl FromStr for PathBuf

type Err = Infallible

The associated error which can be returned from parsing.

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

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

impl FromStrResult for PathBuf

fn from_str_result(s: &str) -> Result<PathBuf, PathError>

impl Hash for PathBuf

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 PartialEq for PathBuf

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

impl StructuralPartialEq for PathBuf