s3m-core 0.18.0

Reusable S3 client and streaming engine behind the s3m CLI
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

use secrecy::SecretString;
use std::convert::TryFrom;

/// Per-transfer options shared across S3 upload/download actions.
///
/// These tune how a request behaves (bandwidth throttling, retry budget) and
/// whether the payload is transformed in flight (compression, encryption).
/// They are deliberately part of the `s3` module — not the CLI — so external
/// consumers of the library can drive uploads/downloads without depending on
/// any command-line types.
#[derive(Debug, Clone, Default)]
pub struct RequestOptions {
    pub throttle: Option<usize>,
    pub retries: u32,
    pub compress: bool,
    pub encrypt: bool,
    pub enc_key: Option<SecretString>,
}

impl RequestOptions {
    #[must_use]
    pub const fn new() -> Self {
        Self {
            throttle: None,
            retries: 3,
            compress: false,
            encrypt: false,
            enc_key: None,
        }
    }

    pub fn set_retries(&mut self, retries: usize) {
        self.retries = u32::try_from(retries).unwrap_or(3);
    }
}

#[cfg(test)]
#[allow(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    clippy::indexing_slicing,
    clippy::unnecessary_wraps
)]
mod tests {
    use super::*;

    #[test]
    fn test_request_options() {
        let mut options = RequestOptions::new();
        assert_eq!(options.throttle, None);
        assert_eq!(options.retries, 3);
        assert!(!options.compress);
        assert!(!options.encrypt);

        options.throttle = Some(10);
        assert_eq!(options.throttle, Some(10));

        options.set_retries(5);
        assert_eq!(options.retries, 5);

        options.compress = true;
        assert!(options.compress);

        options.encrypt = true;
        assert!(options.encrypt);
    }
}