Struct diskplan_filesystem::PlantedPath

pub struct PlantedPath { /* private fields */ }

An absolute path that can be split easily into its Root and relative path parts

Implementations

impl PlantedPath

pub fn new(root: &Root, path: Option<&Utf8Path>) -> Result<Self>

Creates a planted path from a given root and optional full path

If no path is given the root’s path will be used. If a given path is not prefixed with the root’s path, an error is returned.

pub fn root(&self) -> &Utf8Path

The absolute path of the root part of this planted path

pub fn absolute(&self) -> &Utf8Path

The full, absolute path

pub fn relative(&self) -> &Utf8Path

The path relative to the root

pub fn join(&self, name: impl AsRef<str>) -> Result<Self>

Produces a new planted path with the given path part appended

Trait Implementations

impl Display for PlantedPath

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

Formats the value using the given formatter.