Struct Host 

pub struct Host { /* private fields */ }

Represents a GitHub host (github.com or a GHES instance).

Implementations

impl Host

pub fn new(hostname: &str) -> Self

Create a new Host for the given hostname.

For github.com, the API base is https://api.github.com. For GHES instances, the API base is https://<hostname>/api/v3.

Examples

use gor::host::Host;

let host = Host::new("github.com");
assert_eq!(host.api_base(), "https://api.github.com");

let ghes = Host::new("git.example.com");
assert_eq!(ghes.api_base(), "https://git.example.com/api/v3");

pub fn hostname(&self) -> &str

Returns the hostname (e.g. github.com).

pub fn api_base(&self) -> &str

Returns the REST API base URL (e.g. https://api.github.com).

pub fn api_url(&self, path: &str) -> String

Build a full API URL by joining the API base with the given path.

The path should start with a /, e.g. /user or /repos/owner/repo.

Examples

use gor::host::Host;

let host = Host::new("github.com");
assert_eq!(host.api_url("/user"), "https://api.github.com/user");

pub fn device_code_url(&self) -> String

Build the OAuth device code URL for this host.

Examples

use gor::host::Host;

let host = Host::new("github.com");
assert_eq!(
    host.device_code_url(),
    "https://github.com/login/device/code"
);

pub fn access_token_url(&self) -> String

Build the OAuth access token URL for this host.

Examples

use gor::host::Host;

let host = Host::new("github.com");
assert_eq!(
    host.access_token_url(),
    "https://github.com/login/oauth/access_token"
);

pub fn device_activation_url(&self) -> String

Build the device activation URL shown to the user.

Examples

use gor::host::Host;

let host = Host::new("github.com");
assert_eq!(host.device_activation_url(), "https://github.com/login/device");

Trait Implementations

impl Clone for Host

fn clone(&self) -> Host

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Host

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

Formats the value using the given formatter.

impl Default for Host

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Host

impl PartialEq for Host

fn eq(&self, other: &Host) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Host