Skip to main content

Client

Struct Client 

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

A client of one server, with one API key.

Implementations§

Source§

impl Client

Source

pub fn new(config: &HttpsConfig, key: ApiKey) -> Result<Self, HttpsError>

A client for the server config names, authenticating with key.

§Errors

HttpsError::Transport when TLS cannot be set up.

Source

pub fn key(&self) -> &ApiKey

The API key in use.

Source

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

The URL of the API route path, such as /items.

Source

pub async fn send<F>( &self, what: &str, build: F, ) -> Result<Response, HttpsError>
where F: Fn(&Client) -> RequestBuilder,

Sends the request build makes, with the API key, repeating it as error::next says; build is called for every attempt. Returns the answer when it is a success.

§Errors

The last attempt’s HttpsError.

Source

pub async fn get_json<T: DeserializeOwned>( &self, path: &str, ) -> Result<T, HttpsError>

GET of a JSON document.

§Errors

As Client::send, and HttpsError::Protocol for a document that does not read.

Source

pub async fn viewer(&self) -> Result<Viewer, HttpsError>

getViewer: the key in use and the server.

§Errors

As Client::get_json.

Source

pub async fn workspace(&self) -> Result<Workspace, HttpsError>

getWorkspace: the workspace the key opens.

§Errors

As Client::get_json.

Trait Implementations§

Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more