Struct opendal::services::Github

pub struct Github { /* private fields */ }

Available on crate feature services-github only.

github contents services support.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• scan
• presign
• blocking

Configuration

• root: Set the work directory for backend
• token: Github access token
• owner: Github owner
• repo: Github repository

You can refer to GithubBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal::services::Github;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Github::default();

    // set the storage root for OpenDAL
    builder.root("/");
    // set the access token for Github API
    builder.token("your_access_token");
    // set the owner for Github
    builder.owner("your_owner");
    // set the repository for Github
    builder.repo("your_repo");


    let op: Operator = Operator::new(builder)?.finish();

    Ok(())
}

Implementations

impl GithubBuilder

pub fn root(&mut self, root: &str) -> &mut Self

Set root of this backend.

All operations will happen under this root.

pub fn token(&mut self, token: &str) -> &mut Self

Github access_token.

required.

pub fn owner(&mut self, owner: &str) -> &mut Self

Set Github repo owner.

pub fn repo(&mut self, repo: &str) -> &mut Self

Set Github repo name.

pub fn http_client(&mut self, client: HttpClient) -> &mut Self

Specify the http client that used by this service.

Notes

This API is part of OpenDAL’s Raw API. HttpClient could be changed during minor updates.

Trait Implementations

impl Builder for GithubBuilder

fn from_map(map: HashMap<String, String>) -> Self

Converts a HashMap into an GithubBuilder instance.

Arguments

• map - A HashMap containing the configuration values.

Returns

Returns an instance of GithubBuilder.

fn build(&mut self) -> Result<Self::Accessor>

Builds the backend and returns the result of GithubBackend.

const SCHEME: Scheme = Scheme::Github

Associated scheme for this builder. It indicates what underlying service is.

type Accessor = GithubBackend

The accessor that built by this builder.

impl Debug for GithubBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GithubBuilder

fn default() -> GithubBuilder

Returns the “default value” for a type.