Struct github_rs::client::Github

pub struct Github { /* fields omitted */ }

Struct used to make calls to the Github API.

Methods

impl Github

pub fn new<T>(token: T) -> Result<Self> where
    T: ToString, 

Create a new Github client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API Token your requests will work.

pub fn get_token(&self) -> &str

Get the currently set Authorization Token

pub fn set_token<T>(&mut self, token: T) where
    T: ToString, 

Change the currently set Authorization Token using a type that can turn into an &str. Must be a valid API Token for requests to work.

pub fn get_core(&self) -> &Rc<RefCell<Core>>

Exposes the inner event loop for those who need access to it. The recommended way to safely access the core would be

let g = Github::new("API KEY");
let core = g.get_core();
// Handle the error here.
let ref mut core_mut = *core.try_borrow_mut()?;
// Do stuff with the core here. This prevents a runtime failure by
// having two mutable borrows to the core at the same time.

This is how other parts of the API are implemented to avoid causing your program to crash unexpectedly. While you could borrow without the Result being handled it's highly recommended you don't unless you know there is no other mutable reference to it.

pub fn get(&self) -> GetQueryBuilder

Begin building up a GET request to GitHub

pub fn put_empty(&self) -> PutQueryBuilder

Begin building up a PUT request with no data to GitHub

pub fn put<T>(&self, body: T) -> PutQueryBuilder where
    T: Serialize, 

Begin building up a PUT request with data to GitHub

pub fn post<T>(&self, body: T) -> PostQueryBuilder where
    T: Serialize, 

Begin building up a POST request with data to GitHub

pub fn patch<T>(&self, body: T) -> PatchQueryBuilder where
    T: Serialize, 

Begin building up a PATCH request with data to GitHub

pub fn delete<T>(&self, body: T) -> DeleteQueryBuilder where
    T: Serialize, 

Begin building up a DELETE request with data to GitHub

pub fn delete_empty(&self) -> DeleteQueryBuilder

Begin building up a DELETE request without data to GitHub

Trait Implementations

impl<'g> From<&'g Github> for GetQueryBuilder<'g>

fn from(gh: &'g Github) -> Self

Performs the conversion.

impl<'g> From<&'g Github> for PutQueryBuilder<'g>

fn from(gh: &'g Github) -> Self

Performs the conversion.

impl<'g> From<&'g Github> for PostQueryBuilder<'g>

fn from(gh: &'g Github) -> Self

Performs the conversion.

impl<'g> From<&'g Github> for PatchQueryBuilder<'g>

fn from(gh: &'g Github) -> Self

Performs the conversion.

impl<'g> From<&'g Github> for DeleteQueryBuilder<'g>

fn from(gh: &'g Github) -> Self

Performs the conversion.

impl Clone for Github

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.