Struct Endpoints 

pub struct Endpoints { /* private fields */ }

Where GitHub is.

Two bases rather than one, because the device grant lives on github.com while every API call lives on api.github.com. Tests point both at one wiremock server; the paths do not collide.

Implementations

impl Endpoints

pub fn production() -> Self

Production GitHub.

Panics

Never: both constants are parsed at every call and are valid URLs.

pub fn new(api_base: Url, web_base: Url) -> Self

Both bases are normalised to end in / so that relative joins keep the whole base path instead of replacing its last segment.

pub fn for_test_server(root: &str) -> Result<Self, ConfigError>

Point every endpoint at one test server.

Errors

root not being a parseable absolute URL.

pub fn api_base(&self) -> &Url

pub fn web_base(&self) -> &Url

pub fn device_code_url(&self) -> Url

Panics

Never: the path is a constant and the base ends in /.

pub fn access_token_url(&self) -> Url

Panics

Never: the path is a constant and the base ends in /.

pub fn verification_url(&self) -> Url

The canonical page the user code is typed into, and the only device-flow URL this product ever prints.

Panics

Never: the path is a constant and the base ends in /.

Trait Implementations

impl Clone for Endpoints

fn clone(&self) -> Endpoints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoints

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

Formats the value using the given formatter.

impl Default for Endpoints

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Endpoints

impl PartialEq for Endpoints

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Endpoints