Struct Github 

pub struct Github { /* private fields */ }

github contents services support.

Capabilities

Depending on its configuration and the backing system, this service can expose:

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

Inspect the effective capability set with opendal_core::Operator::info and opendal_core::OperatorInfo::capability after building an operator.

Configuration

Use crate::GithubConfig for serializable configuration and this builder’s methods for direct construction. The field and method documentation defines accepted values, defaults, and environment interaction.

Example

Via Builder

use opendal_core::Operator;
use opendal_core::Result;
use opendal_service_github::Github;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Github::default()
        // set the storage root for OpenDAL
        .root("/")
        // set the access token for Github API
        .token("your_access_token")
        // set the owner for Github
        .owner("your_owner")
        // set the repository for Github
        .repo("your_repo");

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

    Ok(())
}

Implementations

impl GithubBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Github access_token.

required.

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

Set Github repo owner.

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

Set Github repo name.

Trait Implementations

impl Builder for GithubBuilder

fn build(self) -> Result<impl Service>

Builds the backend and returns the result of GithubBackend.

type Config = GithubConfig

Associated configuration.

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.