Struct fspp::Path

pub struct Path { /* private fields */ }

Path to a file or folder

When using Path::new(), the function will automatically convert forward/backward slashes depending on the OS

Implementations

impl Path

pub fn new(user_path: &str) -> Self

Create a new path

pub fn exists(&self) -> bool

If the path does infact exist, the return value will be true, else, false

pub fn to_string(&self) -> String

Convert path to string to be printed out or something

pub fn basename(&self) -> String

Get the base name of a path

Examples:

use fspp::*;

let path = Path::new("folder1/folder2/folder3/hello.txt");

assert!(path.basename() == "hello.txt");

pub fn parent_path(&self) -> Self

Get the parent path of a path

Examples:

use fspp::*;

let path = Path::new("folder1/folder2/folder3/hello.txt");

assert!(path.parent_path().to_string() == "folder1/folder2/folder3");

pub fn path_type(&self) -> PathType

Get the path type for a path

Examples:

use fspp::*;

let path = Path::new("hello.txt");

match path.path_type() {
    PathType::File => println!("hello.txt is a file!"),
    PathType::Directory => println!("hello.txt is... a directory!?"),
    PathType::Invalid => println!("hello.txt doesn't exist!"),
};

pub fn split_char() -> char

What is the filesystem split character for the current OS?

Examples:

use fspp::*;

if std::env::consts::OS == "windows" {
    assert!(Path::split_char() == '\\');
}

else {
    assert!(Path::split_char() == '/');
}

pub fn add(&self, extra: &Self) -> Self

Add path segments to an existing path

Examples:

use fspp::*;

let mut path = Path::new("folder1/folder2");
path = path.add(&Path::new("folder3/hello.txt")); // The function is smart enough to fill in the missing '/' at the beginning.

assert!(path.to_string() == "folder1/folder2/folder3/hello.txt");

pub fn add_str(&self, extra: &str) -> Self

Add path segments (&str) to an existing path

Examples:

use fspp::*;

let mut path = Path::new("folder1/folder2");
path = path.add_str("folder3/hello.txt"); // The function is smart enough to fill in the missing '/' at the beginning.

assert!(path.to_string() == "folder1/folder2/folder3/hello.txt");

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Path

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

Deserialize this value from the given Serde deserializer.

impl PartialEq for Path

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Path

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

Serialize this value into the given Serde serializer.

impl Eq for Path

impl StructuralEq for Path

impl StructuralPartialEq for Path