rstr 0.1.0

A library for managing a content-addressable blob store
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

use std::{error, fmt, io};

/// Error raised by the blob store
#[derive(Debug)]
pub enum Error {
    Io(io::Error),
    /// Occurs when trying to instantiate a `BlobRef` with an invalid string.
    ///
    /// # Examples
    ///
    /// ```
    /// use rstr::BlobRef;
    /// let err = BlobRef::new("invalid").unwrap_err();
    /// # // io::Error does not implement PartialEq
    /// // err == Error::InvalidRef
    /// assert_eq!(format!("{}", err), "Error: Invalid reference. Reference must have 64 alphanumerical characters.");
    /// ```
    InvalidRef,

    /// Occurs when trying to perfom some action on a blob that is not present in the
    /// blob store.
    ///
    /// # Examples
    ///
    /// ```
    /// use rstr::{BlobRef, BlobStore, Error};
    ///
    /// let blob_store = BlobStore::new("../tests/test_data_store").unwrap();
    /// let blob_ref = BlobRef::new("b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9").unwrap();
    ///
    /// assert!(!blob_store.exists(&blob_ref));
    /// let err = blob_store.get(&blob_ref).unwrap_err();
    /// # // io::Error does not implement PartialEq
    /// // err == Error::BlobNotFound
    /// assert_eq!(format!("{}", err), "Error: The requested blob was not found in the blob store.");
    ///
    /// let err = blob_store.delete(&blob_ref).unwrap_err();
    /// assert_eq!(format!("{}", err), "Error: The requested blob was not found in the blob store.");
    ///
    /// let err = blob_store.metadata(&blob_ref).unwrap_err();
    /// assert_eq!(format!("{}", err), "Error: The requested blob was not found in the blob store.");
    /// ```
    BlobNotFound,
}

impl error::Error for Error {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match *self {
            Error::Io(ref err) => Some(err),
            Error::BlobNotFound | Error::InvalidRef => None,
        }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            Error::Io(ref err) => err.fmt(f),
            Error::InvalidRef => write!(
                f,
                "Error: Invalid reference. Reference must have 64 alphanumerical characters."
            ),
            Error::BlobNotFound => write!(
                f,
                "Error: The requested blob was not found in the blob store."
            ),
        }
    }
}

impl From<io::Error> for Error {
    fn from(err: io::Error) -> Error {
        match err.kind() {
            // TODO: make sure this doesn't swallow some other NotFound error.
            io::ErrorKind::NotFound => Error::BlobNotFound,
            _ => Error::Io(err),
        }
    }
}

/// Shorthand for [`Result`] type
///
/// [`Result`]: https://doc.rust-lang.org/std/result/enum.Result.html
pub type Result<T> = std::result::Result<T, Error>;