Struct Github 

pub struct Github { /* private fields */ }

A client for communicating with a Github instance.

Implementations

impl Github

pub fn new_app<H, P, I, S>( host: H, app_id: i64, private_key: P, installation_ids: I, ) -> Result<Self, GithubError>

where H: AsRef<str>, P: AsRef<[u8]>, I: IntoIterator<Item = (S, i64)>, S: Into<String>,

Create a new Github client as a GitHub App.

The host parameter is the API endpoint. For example github.com uses api.github.com.

The app_id and private_key are provided when registering the application. The installation_id is an ID associated with a given installation of the application. Its value is present in webhooks, but does not seem to be available generically.

pub fn new_action<H>(host: H) -> Result<Self, GithubError>

where H: AsRef<str>,

Create a new Github client as a GitHub Action.

The host parameter is the API endpoint. For example github.com uses api.github.com.

The app_id and private_key are provided when registering the application. The installation_id is an ID associated with a given installation of the application. Its value is present in webhooks, but does not seem to be available generically.

pub fn send<Q>( &self, owner: &str, query: &QueryBody<Q::Variables>, ) -> Result<Q::ResponseData, GithubError>

where Q: GraphQLQuery, Q::Variables: Debug, for<'d> Q::ResponseData: Deserialize<'d>,

Send a GraphQL query.

Trait Implementations

impl Clone for Github

fn clone(&self) -> Github

Returns a duplicate of the value.

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

Performs copy-assignment from source.