Struct opendal::services::Ghac

pub struct Ghac { /* private fields */ }

Available on crate feature services-ghac only.

GitHub Action Cache Services support.

Capabilities

This service can be used to:

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

Notes

This service is mainly provided by GitHub actions.

Refer to Caching dependencies to speed up workflows for more information.

To make this service work as expected, please make sure to either call endpoint and token to configure the URL and credentials, or that the following environment has been setup correctly:

• ACTIONS_CACHE_URL
• ACTIONS_RUNTIME_TOKEN

They can be exposed by following action:

- name: Configure Cache Env
  uses: actions/github-script@v6
  with:
    script: |
      core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
      core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');

To make delete work as expected, GITHUB_TOKEN should also be set via:

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Limitations

Unlike other services, ghac doesn’t support create empty files. We provide a enable_create_simulation() to support this operation but may result unexpected side effects.

Also, ghac is a cache service which means the data store inside could be automatically evicted at any time.

Configuration

• root: Set the work dir for backend.

Refer to GhacBuilder’s public API docs for more information.

Example

Via Builder

use std::sync::Arc;

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

#[tokio::main]
async fn main() -> Result<()> {
    // Create ghac backend builder.
    let mut builder = Ghac::default();
    // Set the root for ghac, all operations will happen under this root.
    //
    // NOTE: the root must be absolute path.
    builder.root("/path/to/dir");

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

    Ok(())
}

Implementations

impl GhacBuilder

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

set the working directory root of backend

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

set the version that used by cache.

The version is the unique value that provides namespacing. It’s better to make sure this value is only used by this backend.

If not set, we will use opendal as default.

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

Set the endpoint for ghac service.

For example, this is provided as the ACTIONS_CACHE_URL environment variable by the GHA runner.

Default: the value of the ACTIONS_CACHE_URL environment variable.

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

Set the runtime token for ghac service.

For example, this is provided as the ACTIONS_RUNTIME_TOKEN environment variable by the GHA runner.

Default: the value of the ACTIONS_RUNTIME_TOKEN environment variable.

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 GhacBuilder

const SCHEME: Scheme = Scheme::Ghac

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

type Accessor = GhacBackend

The accessor that built by this builder.

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

Construct a builder from given map which contains several parameters needed by underlying service.

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

Consume the accessor builder to build a service.

impl Debug for GhacBuilder

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

Formats the value using the given formatter.

impl Default for GhacBuilder

fn default() -> GhacBuilder

Returns the “default value” for a type.