Struct filey::Filey

pub struct Filey { /* private fields */ }

Implementations

impl Filey

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

Constructs a new Filey.

pub fn path(&self) -> &PathBuf

Returns path to the file.

pub fn file_type(&self) -> Option<FileTypes>

Returns the type of the file. If the path doesn’t exist, return None.

pub fn size(&self) -> Result<u64>

Returns size of the file.

Errors

• The user lacks permissions.
• The file doesn’t exist.

Examples

let size = Filey::new("install.sh").size()?;
println!("{}", size); // 1079

pub fn permissions(&self) -> Result<Permissions>

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

Returns the file name or the directory name. Returns None if the path terminates in …

Examples

let file = Filey::new("src/lib.rs");
assert_eq!(file.file_name()?.as_str(), "lib.rs");

let directory = Filey::new("src/lib.rs");
assert_eq!(directory.file_name()?.as_str(), "src");

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

Returns the stem portion of the file name. Returns None if there is no file name.

Examples

let file = Filey::new("src/lib.rs");
assert_eq!(file.file_stem()?.as_str(), "lib");

pub fn parent_dir(&self) -> Option<String>

Returns the parent directory. Returns None if the path terminates in a root or prefix, or if it’s the empty string.

Examples

let file = Filey::new("src/lib.rs");
assert_eq!(file.parent_dir()?.as_str(), "src");

pub fn absolutize(&mut self) -> Result<&mut Self>

Returns the absolutized path of the file or the directory.

Errors

• The environment variable HOME isn’t set.
• The environment variable’s name contains the equal sign character (=) or the NUL character.
• The environment variable’s value is not valid Unicode.

Examples

let mut file = Filey::new("src/lib.rs");
assert_eq!(file.absolutized()?
    .to_string()
    .as_str(),
    "/home/Tom/src/lib.rs");

pub fn canonicalized(&mut self) -> Result<&mut Self>

Return the canonicalized(absolutized and symbolic links solved) path.

Errors

• The path doesn’t exist.
• A non-final component in path is not a directory.

Examples

// nvim/init.lua -> /home/Lisa/dotfiles/nvim/init.lua
let mut file = Filey::new("nvim/init.lua");
assert_eq!(file.canonicalized()?
    .to_string()
    .as_str(),
    "/home/Lisa/dotfiles/nvim/init.lua");

pub fn expand_user(&mut self) -> Result<&mut Self>

Replaces an initial tilde of the path by the environment variable HOME.

Errors

• The environment variable HOME isn’t set.
• The environment variable’s name contains the equal sign character (=) or the NUL character.
• The environment variable’s value is not valid Unicode.

Examples

let mut directory = Filey::new("~/audio");
assert_eq!(directory.expand_user()?
    .to_string()
    .as_str(),
    "/home/Mike/audio");

pub fn contract_user(&mut self) -> Result<&mut Self>

Replaces path_to_home by tilde.

Errors

• The environment variable HOME isn’t set.
• The environment variable’s name contains the equal sign character (=) or the NUL character.
• The environment variable’s value is not valid Unicode.

Examples

let mut file = Filey::new("/home/Meg/cats.png");
assert_eq!(file.close_user()?.as_str(), "~/cats.png")

pub fn move_to<P: AsRef<Path>>(&mut self, path: P) -> Result<&mut Self>

Move a file or a directory to the given path.

Errors

• The user lacks permissions.
• from(Filey) and to(path: P) are on separate filesystems.

Panics

• Both from and to don’t exist.

Examples

let mut file = Filey::new("cats.png");
file.move_to("photos/animals/")?;
assert_eq!(Path::new("photos/animals/cats.png").exists(), true);

pub fn remove(&self) -> Result<()>

Detects the type of a file and remove the file.

Errors

• The file doesn’t exist.
• The user lacks permissions.

Examples

let file = Filey::new("coredump");
file.remove()?;
assert_eq!(file.exists(), false);

pub fn create(&self, file_type: FileTypes) -> Result<&Self>

Create a new file or directory.

Examples

let directory = File::new("photo/dogs").create(FileTypes::Directory)?;
assert_eq!(directory.exists(), true);

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

Copy the contents of file to another.

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

(Unix only) Create a new symbolic link on the filesystem.

Examples

let mut vimrc_dotfiles = Filey::new("~/dotfiles/vimrc");
vimrc_dotfiles.create(FileTypes::File).symlink("~/.vimrc")?;
assert!(Path::new("~/.vimrc").exists());

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

Create a new hard link on the filesystem.

Errors

The original path is not a file or doesn’t exist.

Examples

let mut file = Filey::new("foo.txt");
file.create(FileTypes::File).hard_link("bar.txt")?;
assert_eq!(Path::new("bar.txt").exists(), true);

pub fn exists(&self) -> bool

pub fn is_file(&self) -> bool

pub fn is_dir(&self) -> bool

pub fn is_symlink(&self) -> bool

Trait Implementations

impl AsRef<Path> for Filey

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Filey

fn clone(&self) -> Filey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Filey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Filey

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

Formats the value using the given formatter.

impl Hash for Filey

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Filey

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Filey

fn eq(&self, other: &Filey) -> 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 PartialOrd for Filey

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

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

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

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

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

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

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

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

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 Serialize for Filey

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 Filey

impl StructuralPartialEq for Filey