Struct aptos_github_client::Client

pub struct Client { /* private fields */ }

Client provides a client around the restful interface to GitHub API version 3. Learn more here: https://developer.github.com/v3

This is not intended for securely storing private data, though perhaps it could with a private repository. The tooling is intended to be used to exchange data in an authenticated fashion across multiple peers.

Implementations

impl Client

pub fn new(
    owner: String,
    repository: String,
    branch: String,
    token: String
) -> Self

pub fn delete_file(&self, path: &str) -> Result<(), Error>

Delete a file from a GitHub repository

pub fn delete_directory(&self, path: &str) -> Result<(), Error>

Recursively delete all files, which as a by product will delete all folders

pub fn get_branches(&self) -> Result<Vec<String>, Error>

Retrieve a list of branches, this is effectively a status check on the repository

pub fn get_directory(&self, path: &str) -> Result<Vec<String>, Error>

Retrieve the name of contents within a given directory, note, there are no such thing as empty directories in git.

pub fn get_file(&self, path: &str) -> Result<String, Error>

Retrieve the contents of a file.

pub fn put(&self, path: &str, content: &str) -> Result<(), Error>

Create or update a file.