Struct RealpathBuilder

pub struct RealpathBuilder { /* private fields */ }

A “builder” that allows customizing options to realpath_raw().

realpath(path, flags) is equivalent to RealpathBuilder::new().flags(flags).realpath(path).

Implementations

impl RealpathBuilder

pub fn new() -> Self

Create a new “builder”.

The returned builder has its flags empty. max_size will be set to 32768 on WASI, and PATH_MAX on other OSes.

pub fn max_len(&mut self, max_len: usize) -> &mut Self

Set the maximum path length allowed before failing with ENAMETOOLONG.

Generally speaking, this is only useful if the OS supports paths longer than PATH_MAX (for example, this is the case on WASI).

Note: In some cases, Self::realpath() may allocate a smaller buffer than this length, then expand it and retry if resolution fails with ENAMETOOLONG.

pub fn flags(&mut self, flags: RealpathFlags) -> &mut Self

Set the flags used to modify path resolution.

See RealpathFlags for more information.

pub fn realpath<P: AsRef<Path>>(&self, path: P) -> Result<PathBuf>

Canonicalize the given path.

Trait Implementations

impl Clone for RealpathBuilder

fn clone(&self) -> RealpathBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RealpathBuilder

fn default() -> Self

Returns the “default value” for a type.