Enum path_abs::PathType

pub enum PathType {
    File(PathFile),
    Dir(PathDir),
}

An an enum containing either a file or a directory.

This is used primarily for:

• The items returned from PathDir::list
• Serializing paths of different types.

Note that for symlinks, this returns the underlying file type.

Variants

File(PathFile)

Dir(PathDir)

Implementations

impl PathType

pub fn new<P: AsRef<Path>>(path: P) -> Result<PathType>

Resolves and returns the PathType of the given path.

If the path exists but is not a file or a directory (i.e. is a symlink), then io::ErrorKind::InvalidInput is returned.

Examples

use path_abs::PathType;

let src = PathType::new("src")?;

pub fn try_from<P: Into<PathAbs>>(path: P) -> Result<PathType>

Consume the PathAbs returning the PathType.

pub fn unwrap_file(self) -> PathFile

Unwrap the PathType as a PathFile.

Examples

use path_abs::PathType;

let lib = PathType::new("src/lib.rs")?.unwrap_file();

pub fn unwrap_dir(self) -> PathDir

Unwrap the PathType as a PathDir.

Examples

use path_abs::PathType;

let src = PathType::new("src")?.unwrap_dir();

pub fn is_dir(&self) -> bool

Return whether this variant is PathType::Dir.

pub fn is_file(&self) -> bool

Return whether this variant is PathType::File.

Trait Implementations

impl AsRef<OsStr> for PathType

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for PathType

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<PathAbs> for PathType

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl AsRef<PathBuf> for PathType

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl Borrow<Path> for PathType

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl<'a> Borrow<Path> for &'a PathType

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Borrow<PathAbs> for PathType

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

impl<'a> Borrow<PathAbs> for &'a PathType

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

impl Borrow<PathBuf> for PathType

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

impl<'a> Borrow<PathBuf> for &'a PathType

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

impl Clone for PathType

fn clone(&self) -> PathType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for PathType

impl From<PathType> for PathAbs

fn from(path: PathType) -> PathAbs

Performs the conversion.

impl Hash for PathType

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for PathType

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PathType> for PathType

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

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

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

This method tests for !=.

impl PartialOrd<PathType> for PathType

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl PathOps for PathType

type Output = PathAbs

fn concat<P: AsRef<Path>>(&self, path: P) -> Result<Self::Output>

Returns a new value representing the concatenation of two paths.

fn join<P: AsRef<Path>>(&self, path: P) -> Self::Output

An exact replica of std::path::Path::join with all of its gotchas and pitfalls,, except returns a more relevant type.

fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> Self::Output

Creates a new path object like self but with the given file name.

fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> Self::Output

Creates a new path object like self but with the given extension.

impl Serialize for PathType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for PathType

impl StructuralPartialEq for PathType