opendal/services/b2/
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/// Config for backblaze b2 services support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct B2Config {
29    /// root of this backend.
30    ///
31    /// All operations will happen under this root.
32    pub root: Option<String>,
33    /// keyID of this backend.
34    ///
35    /// - If application_key_id is set, we will take user's input first.
36    /// - If not, we will try to load it from environment.
37    pub application_key_id: Option<String>,
38    /// applicationKey of this backend.
39    ///
40    /// - If application_key is set, we will take user's input first.
41    /// - If not, we will try to load it from environment.
42    pub application_key: Option<String>,
43    /// bucket of this backend.
44    ///
45    /// required.
46    pub bucket: String,
47    /// bucket id of this backend.
48    ///
49    /// required.
50    pub bucket_id: String,
51}
52
53impl Debug for B2Config {
54    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
55        let mut d = f.debug_struct("B2Config");
56
57        d.field("root", &self.root)
58            .field("application_key_id", &self.application_key_id)
59            .field("bucket_id", &self.bucket_id)
60            .field("bucket", &self.bucket);
61
62        d.finish_non_exhaustive()
63    }
64}
opendal/services/b2/config.rs

opendal/services/b2/
config.rs
