opendal/services/sftp/
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 Sftp Service support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct SftpConfig {
29    /// endpoint of this backend
30    pub endpoint: Option<String>,
31    /// root of this backend
32    pub root: Option<String>,
33    /// user of this backend
34    pub user: Option<String>,
35    /// key of this backend
36    pub key: Option<String>,
37    /// known_hosts_strategy of this backend
38    pub known_hosts_strategy: Option<String>,
39    /// enable_copy of this backend
40    pub enable_copy: bool,
41}
42
43impl Debug for SftpConfig {
44    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
45        f.debug_struct("SftpConfig")
46            .field("endpoint", &self.endpoint)
47            .field("root", &self.root)
48            .finish_non_exhaustive()
49    }
50}