opendal/services/hdfs/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/// [Hadoop Distributed File System (HDFS™)](https://hadoop.apache.org/) support.
25///
26/// Config for Hdfs services support.
27#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
28#[serde(default)]
29#[non_exhaustive]
30pub struct HdfsConfig {
31 /// work dir of this backend
32 pub root: Option<String>,
33 /// name node of this backend
34 pub name_node: Option<String>,
35 /// kerberos_ticket_cache_path of this backend
36 pub kerberos_ticket_cache_path: Option<String>,
37 /// user of this backend
38 pub user: Option<String>,
39 /// enable the append capacity
40 pub enable_append: bool,
41 /// atomic_write_dir of this backend
42 pub atomic_write_dir: Option<String>,
43}
44
45impl Debug for HdfsConfig {
46 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
47 f.debug_struct("HdfsConfig")
48 .field("root", &self.root)
49 .field("name_node", &self.name_node)
50 .field(
51 "kerberos_ticket_cache_path",
52 &self.kerberos_ticket_cache_path,
53 )
54 .field("user", &self.user)
55 .field("enable_append", &self.enable_append)
56 .field("atomic_write_dir", &self.atomic_write_dir)
57 .finish_non_exhaustive()
58 }
59}