rustfs_storage_api/
bucket.rs1use std::fmt::Debug;
16
17use serde::{Deserialize, Serialize};
18use time::OffsetDateTime;
19
20pub const BUCKET_LIFECYCLE_LOCK_OBJECT: &str = "";
23
24#[derive(Debug, Default, Serialize, Deserialize)]
26pub struct MakeBucketOptions {
27 pub lock_enabled: bool,
29 pub versioning_enabled: bool,
31 pub force_create: bool,
33 pub created_at: Option<OffsetDateTime>,
35 pub no_lock: bool,
37}
38
39#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
41pub enum SRBucketDeleteOp {
42 #[default]
44 NoOp,
45 MarkDelete,
47 Purge,
49}
50
51#[derive(Debug, Default, Clone, Serialize, Deserialize)]
53pub struct DeleteBucketOptions {
54 pub no_lock: bool,
56 pub no_recreate: bool,
58 pub force: bool,
60 pub force_if_empty: bool,
62 pub srdelete_op: SRBucketDeleteOp,
64}
65
66#[derive(Debug, Default, Serialize, Deserialize)]
68pub struct BucketOptions {
69 pub deleted: bool,
71 pub cached: bool,
73 pub no_metadata: bool,
75}
76
77#[derive(Debug, Clone, Serialize, Deserialize, Default)]
79pub struct BucketInfo {
80 pub name: String,
82 pub created: Option<OffsetDateTime>,
84 pub deleted: Option<OffsetDateTime>,
86 pub versioning: bool,
88 pub object_locking: bool,
90}
91
92#[async_trait::async_trait]
94pub trait BucketOperations: Send + Sync + Debug {
95 type Error: std::error::Error + Send + Sync + 'static;
96
97 async fn make_bucket(&self, bucket: &str, opts: &MakeBucketOptions) -> Result<(), Self::Error>;
98 async fn get_bucket_info(&self, bucket: &str, opts: &BucketOptions) -> Result<BucketInfo, Self::Error>;
99 async fn list_bucket(&self, opts: &BucketOptions) -> Result<Vec<BucketInfo>, Self::Error>;
100 async fn delete_bucket(&self, bucket: &str, opts: &DeleteBucketOptions) -> Result<(), Self::Error>;
101}
102
103#[cfg(test)]
104mod tests {
105 use super::*;
106
107 #[test]
108 fn bucket_info_serializes_with_existing_fields() {
109 let bucket = BucketInfo {
110 name: "photos".to_owned(),
111 created: Some(OffsetDateTime::UNIX_EPOCH),
112 deleted: None,
113 versioning: true,
114 object_locking: false,
115 };
116
117 let encoded = serde_json::to_string(&bucket).expect("serialize BucketInfo to JSON");
118 let decoded: BucketInfo = serde_json::from_str(&encoded).expect("deserialize BucketInfo from JSON");
119
120 assert_eq!(decoded.name, "photos");
121 assert_eq!(decoded.created, Some(OffsetDateTime::UNIX_EPOCH));
122 assert!(decoded.versioning);
123 assert!(!decoded.object_locking);
124 }
125
126 #[test]
127 fn default_bucket_options_preserve_false_flags() {
128 let opts = BucketOptions::default();
129
130 assert!(!opts.deleted);
131 assert!(!opts.cached);
132 assert!(!opts.no_metadata);
133 }
134
135 #[test]
136 fn default_delete_bucket_options_use_noop_site_replication() {
137 let opts = DeleteBucketOptions::default();
138
139 assert_eq!(opts.srdelete_op, SRBucketDeleteOp::NoOp);
140 assert!(!opts.no_lock);
141 assert!(!opts.no_recreate);
142 assert!(!opts.force);
143 }
144}