s3du 1.1.0

Command line utility for showing space used in AWS S3 buckets
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

// ClientConfig
#![forbid(unsafe_code)]
#![deny(missing_docs)]
use rusoto_core::Region;
use super::ClientMode;

#[cfg(feature = "s3")]
use super::ObjectVersions;

/// Client configuration.
#[derive(Debug)]
pub struct ClientConfig {
    /// The bucket name that the client should report the size of.
    ///
    /// If this isn't given, all discovered S3 buckets will have their sizes
    /// reported.
    pub bucket_name: Option<String>,

    /// The mode that `s3du` will run in.
    ///
    /// This selects which AWS client will be used.
    pub mode: ClientMode,

    /// The region that our AWS client should be created in.
    ///
    /// This will affect bucket discovery.
    pub region: Region,

    /// The S3 object versions that should be used when calculating the bucket
    /// size.
    ///
    /// This only has an effect when running in S3 mode and the field will only
    /// be present when compiled with the `s3` feature.
    #[cfg(feature = "s3")]
    pub object_versions: ObjectVersions,
}

impl Default for ClientConfig {
    /// Returns a default `ClientConfig`.
    ///
    /// If compiled with the `cloudwatch` feature, `CloudWatch` will be the
    /// default `ClientMode`, otherwise `S3` will be the default.
    ///
    /// If compiled without the `s3` feature, the `object_versions` field
    /// will be absent.
    ///
    /// ```rust
    /// ClientConfig {
    ///     bucket_name:     None,
    ///     mode:            ClientMode::CloudWatch,
    ///     region:          Region::UsEast1,
    ///     object_versions: ObjectVersions::Current,
    /// }
    /// ```
    fn default() -> Self {
        #[cfg(feature = "cloudwatch")]
        let mode = ClientMode::CloudWatch;

        #[cfg(all(feature = "s3", not(feature = "cloudwatch")))]
        let mode = ClientMode::S3;

        Self {
            bucket_name: None,
            mode:        mode,
            region:      Region::UsEast1,
            #[cfg(feature = "s3")]
            object_versions: ObjectVersions::Current,
        }
    }
}