touch 0.0.1

A thin wrapper around file and directory operations designed to take remove some of tediousness.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! # Example
//!
//! The following example shows simple command line parsing for an application that
//! requires a number of iterations between zero *(0)* and ten *(10)* to be specified,
//! accepts an optional log file name and responds to the help flag.

use std::{error,io};
use std::fmt::{self, Display, Formatter};

use operation::Operation;

/// An implementation of `Error` which may or may not include a cause.
#[derive(Debug)]
pub struct Error {
    cause: Option<io::Error>,
    message: String
}

impl Error {
    // Constructors
    /// Creates a new `Error` with the provided `Operation` on the given path.
    pub fn new(operation: &Operation, path: &str) -> Self {
        Error { message: Self::message(operation, path), cause: None }
    }

    /// Creates a new `Error` with the provided `Operation` on the given path
    /// and specifies the upstream cause of the error.
    pub fn with_cause(operation: &Operation, path: &str, cause: io::Error) -> Self {
        Error { message: Self::message(operation, path), cause: Some(cause) }
    }

    // Public instance methods
    /// Returns a reference to the upstream cause of this error if one exists.
    pub fn cause(&self) -> Option<&io::Error> {
        self.cause.as_ref()
    }

    fn message(operation: &Operation, path: &str) -> String {
        format!("Unable to {} {}", operation, path)
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl error::Error for Error {
    fn description(&self) -> &str {
        &self.message
    }
}