Struct oxide_api::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Entrypoint for interacting with the API client.

Implementations

impl Client

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

Create a new 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 key your requests will work.

pub fn with_host<H>(&self, host: H) -> Self where
H: ToString,

Override the default host for the client.

pub fn new_from_env() -> Self

Create a new Client struct from environment variables. 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 key and your requests will work. We pass in the token and refresh token to the client so if you are storing it in a database, you can get it first.

pub async fn request_raw(
    &self,
    method: Method,
    uri: &str,
    body: Option<Body>
) -> Result<Response>

pub fn hardware(&self) -> Hardware

Return a reference to an interface that provides access to hardware operations.

pub fn organizations(&self) -> Organizations

Return a reference to an interface that provides access to organizations operations.

pub fn projects(&self) -> Projects

Return a reference to an interface that provides access to projects operations.

pub fn users(&self) -> Users

Return a reference to an interface that provides access to users operations.

pub fn roles(&self) -> Roles

Return a reference to an interface that provides access to roles operations.

pub fn instances(&self) -> Instances

Return a reference to an interface that provides access to instances operations.

pub fn sagas(&self) -> Sagas

Return a reference to an interface that provides access to sagas operations.

pub fn metrics(&self) -> Metrics

Return a reference to an interface that provides access to metrics operations.

pub fn networking(&self) -> Networking

Return a reference to an interface that provides access to networking operations.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> DynClone for T where
T: Clone,

pub fn __clone_box(&self, Private) -> *mut ()

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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