Struct path_abs::PathFile

pub struct PathFile(_);

a PathAbs that is guaranteed to be a file, with associated methods.

Methods

impl PathFile

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

Instantiate a new PathFile. The file must exist or io::Error will be returned.

Returns io::ErrorKind::InvalidInput if the path exists but is not a file.

Examples

use path_abs::PathFile;

let lib = PathFile::new("src/lib.rs").unwrap();

fn from_abs(abs: PathAbs) -> Result<PathFile>

Consume the PathAbs validating that the path is a file and returning PathFile. The file must exist or io::Error will be returned.

If the path is actually a dir returns io::ErrorKind::InvalidInput.

This does not call Path::cannonicalize(), instead trusting that the input already a fully qualified path.

Examples

use path_abs::{PathAbs, PathFile};

let lib_abs = PathAbs::new("src/lib.rs").unwrap();
let lib_file = PathFile::from_abs(lib_abs).unwrap();

fn create<P: AsRef<Path>>(path: P) -> Result<PathFile>

Instantiate a new PathFile, creating it first if it doesn't exist.

Examples

use path_abs::PathFile;


let example = "target/example.txt";


let file = PathFile::create(example).unwrap();

// It can be done twice with no effect.
let _ = PathFile::create(example).unwrap();

fn read_string(&self) -> Result<String>

Read the entire contents of the file into a String.

Examples

use path_abs::PathFile;


let example = "target/example.txt";
let file = PathFile::create(example).unwrap();

let expected = "foo\nbar";
file.write_str(expected).unwrap();
assert_eq!(expected, file.read_string().unwrap());

fn write_str(&self, s: &str) -> Result<()>

Write the str to a file, truncating it first if it exist and creating it otherwise.

Examples

use path_abs::PathFile;


let example = "target/example.txt";
let file = PathFile::create(example).unwrap();

let expected = "foo\nbar";
file.write_str(expected).unwrap();
assert_eq!(expected, file.read_string().unwrap());

fn append_str(&self, s: &str) -> Result<()>

Append the str to a file, creating it if it doesn't exist.

If the str is empty, this is equivalent to the unix touch except it does NOT update the timestamp

Examples

use path_abs::PathFile;

let example = "target/example.txt";
let file = PathFile::create(example).unwrap();

let expected = "foo\nbar\nbaz";
file.append_str("foo\nbar").unwrap();
file.append_str("\nbaz").unwrap();
assert_eq!(expected, file.read_string().unwrap());

fn mock<P: AsRef<Path>>(path: P) -> PathFile

Create a mock file type. For use in tests only.

See the docs for PathAbs::mock

Methods from Deref<Target = PathAbs>

fn into_file(self) -> Result<PathFile>

Resolve the PathAbs as a PathFile. Return an error if it is not a file.

fn into_dir(self) -> Result<PathDir>

Resolve the PathAbs as a PathDir. Return an error if it is not a directory.

fn parent_dir(&self) -> Option<PathDir>

Get the parent directory of this path as a PathDir.

This does not make additinal syscalls, as the parent by definition must be a directory and exist.

Examples

use path_abs::{PathDir, PathFile};

let lib = PathFile::new("src/lib.rs").unwrap();
let src = lib.parent_dir().unwrap();
assert_eq!(PathDir::new("src").unwrap(), src);

Trait Implementations

impl Clone for PathFile

fn clone(&self) -> PathFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PathFile

impl Hash for PathFile

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl PartialEq for PathFile

fn eq(&self, __arg_0: &PathFile) -> bool

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

fn ne(&self, __arg_0: &PathFile) -> bool

This method tests for !=.

impl PartialOrd for PathFile

fn partial_cmp(&self, __arg_0: &PathFile) -> Option<Ordering>

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

fn lt(&self, __arg_0: &PathFile) -> bool

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

fn le(&self, __arg_0: &PathFile) -> bool

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

fn gt(&self, __arg_0: &PathFile) -> bool

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

fn ge(&self, __arg_0: &PathFile) -> bool

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

impl Ord for PathFile

fn cmp(&self, __arg_0: &PathFile) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Debug for PathFile

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

Formats the value using the given formatter.

impl AsRef<PathAbs> for PathFile

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl AsRef<Path> for PathFile

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<PathBuf> for PathFile

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl Deref for PathFile

type Target = PathAbs

The resulting type after dereferencing.

fn deref(&self) -> &PathAbs

Dereferences the value.

impl Serialize for PathFile

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for PathFile

fn deserialize<D>(deserializer: D) -> Result<PathFile, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.