opendal/services/gridfs/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 Grid file system support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct GridfsConfig {
29 /// The connection string of the MongoDB service.
30 pub connection_string: Option<String>,
31 /// The database name of the MongoDB GridFs service to read/write.
32 pub database: Option<String>,
33 /// The bucket name of the MongoDB GridFs service to read/write.
34 pub bucket: Option<String>,
35 /// The chunk size of the MongoDB GridFs service used to break the user file into chunks.
36 pub chunk_size: Option<u32>,
37 /// The working directory, all operations will be performed under it.
38 pub root: Option<String>,
39}
40
41impl Debug for GridfsConfig {
42 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
43 f.debug_struct("GridFsConfig")
44 .field("database", &self.database)
45 .field("bucket", &self.bucket)
46 .field("chunk_size", &self.chunk_size)
47 .field("root", &self.root)
48 .finish()
49 }
50}