pub struct Client { /* private fields */ }
Expand description

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§

source§

impl Client

source

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

source

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

Delete a file from a GitHub repository

source

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

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

source

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

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

source

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.

source

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

Retrieve the contents of a file.

source

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

Create or update a file.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.