Skip to main content

HttpClient

Struct HttpClient 

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

HTTP client for OpenCode REST API.

Implementations§

Source§

impl HttpClient

Source

pub fn new(cfg: HttpConfig) -> Result<Self>

Create a new HTTP client with the given configuration.

§Errors

Returns an error if the HTTP client cannot be built.

Source

pub fn from_parts( base_url: Url, directory: Option<PathBuf>, http: Option<ReqClient>, ) -> Result<Self>

Create from base URL, directory, and optional existing client.

§Errors

Returns an error if the HTTP client cannot be built.

Source

pub fn base(&self) -> &str

Get the base URL.

Source

pub fn directory(&self) -> Option<&str>

Get the directory context.

Source

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

GET request returning deserialized JSON.

§Errors

Returns an error if the request fails or response cannot be deserialized.

Source

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

DELETE request returning deserialized JSON.

§Errors

Returns an error if the request fails or response cannot be deserialized.

Source

pub async fn delete_empty(&self, path: &str) -> Result<()>

DELETE request expecting no response body.

§Errors

Returns an error if the request fails.

Source

pub async fn post<TReq: Serialize, TRes: DeserializeOwned>( &self, path: &str, body: &TReq, ) -> Result<TRes>

POST request with JSON body returning deserialized JSON.

§Errors

Returns an error if the request fails or response cannot be deserialized.

Source

pub async fn post_empty<TReq: Serialize>( &self, path: &str, body: &TReq, ) -> Result<()>

POST request expecting no response body.

§Errors

Returns an error if the request fails.

Source

pub async fn patch<TReq: Serialize, TRes: DeserializeOwned>( &self, path: &str, body: &TReq, ) -> Result<TRes>

PATCH request with JSON body returning deserialized JSON.

§Errors

Returns an error if the request fails or response cannot be deserialized.

Source

pub async fn put<TReq: Serialize, TRes: DeserializeOwned>( &self, path: &str, body: &TReq, ) -> Result<TRes>

PUT request with JSON body returning deserialized JSON.

§Errors

Returns an error if the request fails or response cannot be deserialized.

Source

pub async fn request_json<T: DeserializeOwned>( &self, method: Method, path: &str, body: Option<Value>, ) -> Result<T>

Make a JSON request and deserialize the response.

§Errors

Returns an error if the request fails or the response cannot be deserialized.

Source

pub async fn request_empty( &self, method: Method, path: &str, body: Option<Value>, ) -> Result<()>

Make a request that expects no response body.

§Errors

Returns an error if the request fails or returns a non-success status.

Trait Implementations§

Source§

impl Clone for HttpClient

Source§

fn clone(&self) -> HttpClient

Returns a duplicate 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§

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: 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: 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