Apache OpenDAL™ GitHub Contents Service

opendal-service-github provides access to repository files through the GitHub Contents API for applications built with Apache OpenDAL™.

Use through opendal

Applications should normally enable this service through the opendal facade with the services-github feature:

cargo add opendal --features services-github

The service is available as opendal::services::Github. Configure the service builder, then pass it to opendal::Operator::new.

Use with opendal-core

Add the split crates directly:

cargo add opendal-core opendal-service-github

Pass a configured service builder to Operator::new:

use opendal_core::{Operator, OperatorRegistry, Result};
use opendal_service_github::{register_github_service, Github};

fn build_operator(builder: Github) -> Result<Operator> {
    Operator::new(builder)
}

fn register_for_uri() {
    register_github_service(OperatorRegistry::get());
}

register_for_uri is only needed for scheme-driven construction through Operator::from_uri or Operator::via_iter.

Services that send HTTP requests also require an HTTP transport in OperationContext. See the opendal-core composition example.

Documentation

• Service configuration and examples
• Rust API documentation
• Apache OpenDAL documentation

License

Licensed under the Apache License, Version 2.0.