opendal/services/azblob/
config.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20
21use serde::Deserialize;
22use serde::Serialize;
23
24/// Azure Storage Blob services support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26pub struct AzblobConfig {
27    /// The root of Azblob service backend.
28    ///
29    /// All operations will happen under this root.
30    pub root: Option<String>,
31
32    /// The container name of Azblob service backend.
33    pub container: String,
34
35    /// The endpoint of Azblob service backend.
36    ///
37    /// Endpoint must be full uri, e.g.
38    ///
39    /// - Azblob: `https://accountname.blob.core.windows.net`
40    /// - Azurite: `http://127.0.0.1:10000/devstoreaccount1`
41    pub endpoint: Option<String>,
42
43    /// The account name of Azblob service backend.
44    pub account_name: Option<String>,
45
46    /// The account key of Azblob service backend.
47    pub account_key: Option<String>,
48
49    /// The encryption key of Azblob service backend.
50    pub encryption_key: Option<String>,
51
52    /// The encryption key sha256 of Azblob service backend.
53    pub encryption_key_sha256: Option<String>,
54
55    /// The encryption algorithm of Azblob service backend.
56    pub encryption_algorithm: Option<String>,
57
58    /// The sas token of Azblob service backend.
59    pub sas_token: Option<String>,
60
61    /// The maximum batch operations of Azblob service backend.
62    pub batch_max_operations: Option<usize>,
63}
64
65impl Debug for AzblobConfig {
66    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
67        let mut ds = f.debug_struct("AzblobConfig");
68
69        ds.field("root", &self.root);
70        ds.field("container", &self.container);
71        ds.field("endpoint", &self.endpoint);
72
73        if self.account_name.is_some() {
74            ds.field("account_name", &"<redacted>");
75        }
76        if self.account_key.is_some() {
77            ds.field("account_key", &"<redacted>");
78        }
79        if self.sas_token.is_some() {
80            ds.field("sas_token", &"<redacted>");
81        }
82
83        ds.finish()
84    }
85}
opendal/services/azblob/config.rs

opendal/services/azblob/
config.rs
