Skip to main content

HotClient

Struct HotClient 

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

Hot API v1 client. Construct it with HotClient::builder; the resource accessors mirror the Hot API resources.

Implementations§

Source§

impl HotClient

Source

pub fn new(token: impl Into<String>) -> HotClient

Returns a client with default configuration.

Source

pub fn builder(token: impl Into<String>) -> HotClientBuilder

Returns a builder using the given Hot API key, session token, or service key.

Source

pub fn base_url(&self) -> &str

The configured base URL without the /v1 suffix.

Source

pub fn builds(&self) -> BuildsResource

Source

pub fn context(&self) -> ContextResource

Source

pub fn domains(&self) -> DomainsResource

Source

pub fn env(&self) -> EnvResource

Source

pub fn events(&self) -> EventsResource

Source

pub fn files(&self) -> FilesResource

Source

pub fn org(&self) -> OrgResource

Source

pub fn projects(&self) -> ProjectsResource

Source

pub fn runs(&self) -> RunsResource

Source

pub fn service_keys(&self) -> ServiceKeysResource

Source

pub fn sessions(&self) -> SessionsResource

Source

pub fn streams(&self) -> StreamsResource

Source

pub async fn request( &self, method: Method, path: &str, body: Option<&Value>, query: &[(&str, &str)], ) -> Result<JsonObject>

Calls a JSON API endpoint that does not yet have a resource helper. path is relative to /v1 and the returned object is the response envelope.

Source

pub fn request_builder(&self, method: Method, path: &str) -> RequestBuilder

Returns an authorized RequestBuilder for a path relative to /v1, for endpoints needing full control (raw bodies, custom headers). Send it with HotClient::execute to get API error mapping.

Source

pub async fn execute(&self, builder: RequestBuilder) -> Result<Response>

Sends a request built with HotClient::request_builder, mapping non-2xx responses to crate::ApiError.

Trait Implementations§

Source§

impl Clone for HotClient

Source§

fn clone(&self) -> HotClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

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