opendal/services/github/
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 GitHub services support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct GithubConfig {
29    /// root of this backend.
30    ///
31    /// All operations will happen under this root.
32    pub root: Option<String>,
33    /// GitHub access_token.
34    ///
35    /// optional.
36    /// If not provided, the backend will only support read operations for public repositories.
37    /// And rate limit will be limited to 60 requests per hour.
38    pub token: Option<String>,
39    /// GitHub repo owner.
40    ///
41    /// required.
42    pub owner: String,
43    /// GitHub repo name.
44    ///
45    /// required.
46    pub repo: String,
47}
48
49impl Debug for GithubConfig {
50    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
51        let mut d = f.debug_struct("GithubConfig");
52
53        d.field("root", &self.root)
54            .field("owner", &self.owner)
55            .field("repo", &self.repo);
56
57        d.finish_non_exhaustive()
58    }
59}
opendal/services/github/config.rs

opendal/services/github/
config.rs
