Struct abscissa_core::path::AbsPathBuf

source · [−]

pub struct AbsPathBuf(_);

Expand description

An owned path on the filesystem which is guaranteed to be canonical.

More specifically: it is at least guaranteed to be canonical at the time it is created. There are potential TOCTTOU problems if the underlying filesystem structure changes after path canonicalization.

Implementations

source

impl CanonicalPathBuf

source

pub fn canonicalize(path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,

Create a canonical path by first canonicalizing the given path.

source

pub fn new(path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,

Create a canonical path, returning error if the supplied path is not canonical.

source

pub fn as_canonical_path(&self) -> &CanonicalPath

Return a CanonicalPath reference.

source

pub fn set_file_name<S>(&mut self, file_name: S) where
S: AsRef<OsStr>,

Updates self’s filename ala the same method on PathBuf

source

pub fn set_extension<S>(&mut self, extension: S) -> bool where
S: AsRef<OsStr>,

Updates self.extension to extension.

Returns false and does nothing if self.file_name is None, returns true and updates the extension otherwise. If self.extension is None, the extension is added; otherwise it is replaced.

source

pub fn into_path_buf(self) -> PathBuf

Consumes the CanonicalPathBuf, yielding its internal PathBuf storage.

source

pub fn into_os_string(self) -> OsString

Consumes the CanonicalPathBuf, yielding its internal OsString storage.

source

pub fn as_path(&self) -> &Path

Return a Path reference.

source

pub fn as_os_str(&self) -> &OsStr

Return an OsStr reference.

source

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

Yields a &str slice if the path is valid unicode.

source

pub fn parent(&self) -> Result<CanonicalPathBuf, Error>

Return a canonical parent path of this path, or io::Error if the path is the root directory or another canonicalization error occurs.

source

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

Returns the final component of the path, if there is one.

source

pub fn starts_with(&self, base: P) -> bool where
P: AsRef<Path>,

Determines whether base is a prefix of self.

source

pub fn ends_with(&self, child: P) -> bool where
P: AsRef<Path>,

Determines whether child is a suffix of self.

source

pub fn file_stem(&self) -> Option<&OsStr>

Extracts the stem (non-extension) portion of self.file_name.

source

pub fn extension(&self) -> Option<&OsStr>

Extracts the extension of self.file_name, if possible.

source

pub fn with_file_name<S>(&self, file_name: S) -> Result<CanonicalPathBuf, Error> where
S: AsRef<OsStr>,

Creates an owned CanonicalPathBuf like self but with the given file name.

source

pub fn with_extension<S>(&self, extension: S) -> Result<CanonicalPathBuf, Error> where
S: AsRef<OsStr>,

Creates an owned CanonicalPathBuf like self but with the given extension.

source

pub fn components(&self) -> Components<'_>

Produces an iterator over the Components of a path

source

pub fn iter(&self) -> Iter<'_>

Produces an iterator over the path’s components viewed as OsStr slices.

source

pub fn display(&self) -> Display<'_>

Returns an object that implements Display for safely printing paths that may contain non-Unicode data.

source

pub fn metadata(&self) -> Result<Metadata, Error>

Queries the file system to get information about a file, directory, etc.

Unlike the std version of this method, it will not follow symlinks, since as a canonical path we should be symlink-free.

source

pub fn join(&self, path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,

Join a path onto a canonical path, returning a CanonicalPathBuf.

source

pub fn read_dir(&self) -> Result<ReadDir, Error>

Returns an iterator over the entries within a directory.

The iterator will yield instances of io::Result. New errors may be encountered after an iterator is initially constructed.

This is an alias to fs::read_dir.

source

pub fn exists(&self) -> bool

Does this path exist?

source

pub fn is_file(&self) -> bool

Is this path a file?

source

pub fn is_dir(&self) -> bool

Is this path a directory?

Trait Implementations

source

impl AsRef<CanonicalPath> for CanonicalPathBuf

source

pub fn as_ref(&self) -> &CanonicalPath

Performs the conversion.

source

impl AsRef<OsStr> for CanonicalPathBuf

source

pub fn as_ref(&self) -> &OsStr

Performs the conversion.

source

impl AsRef<Path> for CanonicalPathBuf

source

pub fn as_ref(&self) -> &Path

Performs the conversion.

source

impl Borrow<CanonicalPath> for CanonicalPathBuf

source

pub fn borrow(&self) -> &CanonicalPath

Immutably borrows from an owned value. Read more

source

impl Clone for CanonicalPathBuf

source

pub fn clone(&self) -> CanonicalPathBuf

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for CanonicalPathBuf

source

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

Formats the value using the given formatter. Read more

source

impl Hash for CanonicalPathBuf

source

pub fn hash<H>(&self, state: &mut H) where
__H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl Ord for CanonicalPathBuf

source

pub fn cmp(&self, other: &CanonicalPathBuf) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl PartialEq<CanonicalPathBuf> for CanonicalPathBuf

source

pub fn eq(&self, other: &CanonicalPathBuf) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

pub fn ne(&self, other: &CanonicalPathBuf) -> bool

This method tests for !=.

source

impl PartialOrd<CanonicalPathBuf> for CanonicalPathBuf

source

pub fn partial_cmp(&self, other: &CanonicalPathBuf) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

impl Eq for CanonicalPathBuf

source

impl StructuralEq for CanonicalPathBuf

source

impl StructuralPartialEq for CanonicalPathBuf

Auto Trait Implementations

impl RefUnwindSafe for CanonicalPathBuf

impl Send for CanonicalPathBuf

impl Sync for CanonicalPathBuf

impl Unpin for CanonicalPathBuf

impl UnwindSafe for CanonicalPathBuf

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> AsAny for T where
T: Any,

source

fn as_any(&self) -> &dyn Any

Borrow this concrete type as a &dyn Any

source

fn as_mut_any(&mut self) -> &mut dyn Any

Borrow this concrete type as a &mut dyn Any

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where
C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where
C: Color,

Set the background color generically. Read more

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

fn bold(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct abscissa_core::path::AbsPathBuf

Implementations

impl CanonicalPathBuf

pub fn canonicalize<P>(path: P) -> Result<CanonicalPathBuf, Error> where P: AsRef<Path>,

pub fn new<P>(path: P) -> Result<CanonicalPathBuf, Error> where P: AsRef<Path>,

pub fn as_canonical_path(&self) -> &CanonicalPath

pub fn set_file_name<S>(&mut self, file_name: S) where S: AsRef<OsStr>,

pub fn set_extension<S>(&mut self, extension: S) -> bool where S: AsRef<OsStr>,

pub fn into_path_buf(self) -> PathBuf

pub fn into_os_string(self) -> OsString

pub fn as_path(&self) -> &Path

pub fn as_os_str(&self) -> &OsStr

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

pub fn parent(&self) -> Result<CanonicalPathBuf, Error>

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

pub fn starts_with<P>(&self, base: P) -> bool where P: AsRef<Path>,

pub fn ends_with<P>(&self, child: P) -> bool where P: AsRef<Path>,

pub fn file_stem(&self) -> Option<&OsStr>

pub fn extension(&self) -> Option<&OsStr>

pub fn with_file_name<S>(&self, file_name: S) -> Result<CanonicalPathBuf, Error> where S: AsRef<OsStr>,

pub fn with_extension<S>(&self, extension: S) -> Result<CanonicalPathBuf, Error> where S: AsRef<OsStr>,

pub fn components(&self) -> Components<'_>

pub fn iter(&self) -> Iter<'_>

pub fn display(&self) -> Display<'_>

pub fn metadata(&self) -> Result<Metadata, Error>

pub fn join<P>(&self, path: P) -> Result<CanonicalPathBuf, Error> where P: AsRef<Path>,

pub fn read_dir(&self) -> Result<ReadDir, Error>

pub fn exists(&self) -> bool

pub fn is_file(&self) -> bool

pub fn is_dir(&self) -> bool

Trait Implementations

impl AsRef<CanonicalPath> for CanonicalPathBuf

pub fn as_ref(&self) -> &CanonicalPath

impl AsRef<OsStr> for CanonicalPathBuf

pub fn as_ref(&self) -> &OsStr

impl AsRef<Path> for CanonicalPathBuf

pub fn as_ref(&self) -> &Path

impl Borrow<CanonicalPath> for CanonicalPathBuf

pub fn borrow(&self) -> &CanonicalPath

impl Clone for CanonicalPathBuf

pub fn clone(&self) -> CanonicalPathBuf

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

impl Debug for CanonicalPathBuf

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

impl Hash for CanonicalPathBuf

pub fn hash<__H>(&self, state: &mut __H) where __H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl Ord for CanonicalPathBuf

pub fn cmp(&self, other: &CanonicalPathBuf) -> Ordering

fn max(self, other: Self) -> Self

fn min(self, other: Self) -> Self

fn clamp(self, min: Self, max: Self) -> Self

impl PartialEq<CanonicalPathBuf> for CanonicalPathBuf

pub fn eq(&self, other: &CanonicalPathBuf) -> bool

pub fn ne(&self, other: &CanonicalPathBuf) -> bool

impl PartialOrd<CanonicalPathBuf> for CanonicalPathBuf

pub fn partial_cmp(&self, other: &CanonicalPathBuf) -> Option<Ordering>

fn lt(&self, other: &Rhs) -> bool

fn le(&self, other: &Rhs) -> bool

fn gt(&self, other: &Rhs) -> bool

fn ge(&self, other: &Rhs) -> bool

impl Eq for CanonicalPathBuf

impl StructuralEq for CanonicalPathBuf

impl StructuralPartialEq for CanonicalPathBuf

Auto Trait Implementations

impl RefUnwindSafe for CanonicalPathBuf

impl Send for CanonicalPathBuf

impl Sync for CanonicalPathBuf

impl Unpin for CanonicalPathBuf

impl UnwindSafe for CanonicalPathBuf

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: Any,

fn as_any(&self) -> &dyn Any

fn as_mut_any(&mut self) -> &mut dyn Any

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

pub fn canonicalize<P>(path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,

pub fn new<P>(path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,

pub fn set_file_name<S>(&mut self, file_name: S) where
S: AsRef<OsStr>,

pub fn set_extension<S>(&mut self, extension: S) -> bool where
S: AsRef<OsStr>,

pub fn starts_with<P>(&self, base: P) -> bool where
P: AsRef<Path>,

pub fn ends_with<P>(&self, child: P) -> bool where
P: AsRef<Path>,

pub fn with_file_name<S>(&self, file_name: S) -> Result<CanonicalPathBuf, Error> where
S: AsRef<OsStr>,

pub fn with_extension<S>(&self, extension: S) -> Result<CanonicalPathBuf, Error> where
S: AsRef<OsStr>,

pub fn join<P>(&self, path: P) -> Result<CanonicalPathBuf, Error> where
P: AsRef<Path>,

pub fn hash<H>(&self, state: &mut H) where
__H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> AsAny for T where
T: Any,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>