Struct tvix_castore::path::PathBuf

pub struct PathBuf {
    inner: Vec<u8>,
}

Represents a owned PathBuf in the castore model. These are always relative, and platform-independent, which distinguishes them from the ones provided in the standard library.

Fields

inner: Vec<u8>

Implementations

impl PathBuf

pub fn new() -> PathBuf

pub fn with_capacity(capacity: usize) -> PathBuf

pub fn try_push(&mut self, name: &[u8]) -> Result<(), Error>

Adjoins name to self.

unsafe fn from_bytes_unchecked(bytes: Vec<u8>) -> PathBuf

Convert a byte vector to a PathBuf, without checking validity.

pub fn from_host_path( host_path: &Path, canonicalize_dotdot: bool, ) -> Result<Self, Error>

Convert from a [&std::path::Path] to Self.

• Self uses / as path separator.
• Absolute paths are always rejected, are are these with custom prefixes.
• Repeated separators are deduplicated.
• Occurrences of . are normalized away.
• A trailing slash is normalized away.

A canonicalize_dotdot boolean controls whether .. will get canonicalized if possible, or should return an error.

For more exotic paths, this conversion might produce different results on different platforms, due to different underlying byte representations, which is why it’s restricted to unix for now.

pub fn into_boxed_path(self) -> Box<Path>

pub fn into_bytes(self) -> Vec<u8>

Methods from Deref<Target = Path>

pub const ROOT: &'static Path = _

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

Returns the path without its final component, if there is one.

Note that the parent of a bare file name is Path::ROOT. Path::ROOT is the only path without a parent.

pub fn try_join(&self, name: &[u8]) -> Result<PathBuf, Error>

Creates a PathBuf with name adjoined to self.

pub fn components(&self) -> impl Iterator<Item = PathComponent> + '_

Provides an iterator over the components of the path, which are invividual PathComponent. In case the path is empty, an empty iterator is returned.

pub fn components_bytes(&self) -> impl Iterator<Item = &[u8]>

Produces an iterator over the components of the path, which are individual byte slices. In case the path is empty, an empty iterator is returned.

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

Returns the final component of the Path, if there is one, in bytes.

pub fn file_name_bytes(&self) -> Option<&[u8]>

Returns the final component of the Path, if there is one, in bytes.

pub fn as_bytes(&self) -> &[u8]

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 Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Clone for PathBuf

fn clone(&self) -> PathBuf

Returns a copy 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() -> PathBuf

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<&Path> for PathBuf

fn from(value: &Path) -> Self

Converts to this type from the input type.

impl From<Box<Path>> for PathBuf

fn from(value: Box<Path>) -> Self

Converts to this type from the input type.

impl FromStr for PathBuf

type Err = Error

The associated error which can be returned from parsing.

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

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

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