saltlick 0.5.0

A library for encrypting and decrypting file streams using libsodium
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

// Copyright (c) 2019, Nick Stevens <nick@bitcurry.com>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/license/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

/// Supported Saltlick file format version.
#[derive(Clone, Copy, Debug, Hash, Eq, Ord, PartialEq, PartialOrd)]
pub enum Version {
    /// Format version 1.
    V1,

    /// Any other unrecognized version.
    Unknown(u8),
}

impl Version {
    /// Convert this version to a u8 representation.
    pub fn to_u8(self) -> u8 {
        match self {
            Version::V1 => 1,
            Version::Unknown(version) => version,
        }
    }

    /// Convert a u8 representation to a version.
    ///
    /// Note: the conversion is infalliable, but it is important to check that
    /// the version decoded is an understood one, as any unknown values map to
    /// the `Unknown` variant.
    pub fn from_u8(value: u8) -> Version {
        match value {
            1 => Version::V1,
            other => Version::Unknown(other),
        }
    }

    /// True if this is not a known version.
    pub fn is_unknown(self) -> bool {
        match self {
            Version::Unknown(_) => true,
            _ => false,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::Version;

    #[test]
    fn to_u8_test() {
        let v1 = Version::V1;
        assert_eq!(1u8, v1.to_u8());
        assert!(!v1.is_unknown());
        let unknown = Version::Unknown(0u8);
        assert_eq!(0u8, unknown.to_u8());
        assert!(unknown.is_unknown());
    }

    #[test]
    fn from_u8_test() {
        let v1 = 1u8;
        assert_eq!(Version::V1, Version::from_u8(v1));
        let unknown = 0u8;
        assert_eq!(Version::Unknown(0u8), Version::from_u8(unknown));
    }
}