lusl 2.1.0

Lossless Uncompressed Serializer Library
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

/// Option struct for serializing and deserializing
///
/// Pass this object to the serializer or deserializer.
///
/// #Examples
/// ```
/// use lusl::SerializeOption;
/// let default_option = SerializeOption::default();
/// assert_eq!(default_option.is_encrypted(), false);
/// assert_eq!(default_option.is_compressed(), false);
/// assert_eq!(default_option.password(), None);
/// let option = SerializeOption::new()
/// .to_encrypt("test_password")
/// .to_compress(true);
/// assert_eq!(option.is_encrypted(), true);
/// assert_eq!(option.is_compressed(), true);
/// assert_eq!(option.password(), Some(String::from("test_password")));
/// ```
#[derive(Clone)]
pub struct SerializeOption {
    encrypt: bool,
    compress: bool,
    password: Option<String>,
}

impl Default for SerializeOption {
    fn default() -> Self {
        Self {
            encrypt: false,
            compress: false,
            password: None,
        }
    }
}

impl SerializeOption {
    /// Make a new SerializeOption object.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the encryption option. Use with builder pattern.
    pub fn to_encrypt(mut self, password: &str) -> Self {
        self.encrypt = true;
        self.password = Some(String::from(password));
        self
    }

    /// Set the compression option. Use with builder pattern.
    pub fn to_compress(mut self, compress: bool) -> Self {
        self.compress = compress;
        self
    }

    /// Set the encryption option.
    pub fn encrypt(&mut self, password: &str) {
        self.encrypt = true;
        self.password = Some(String::from(password));
    }

    /// Set the compression option.
    pub fn compress(&mut self, compress: bool) {
        self.compress = compress;
    }

    /// Returns true if the option is set to encrypt.
    pub fn is_encrypted(&self) -> bool {
        self.encrypt
    }

    /// Returns true if the option is set to compress.
    pub fn is_compressed(&self) -> bool {
        self.compress
    }

    /// Returns the password if the option is set to encrypt.
    pub fn password(&self) -> Option<String> {
        return self.password.clone();
    }
}