Skip to main content

HttpClient

Struct HttpClient 

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

Async HTTP client for Synth API.

Provides Bearer token authentication and automatic JSON handling.

§Example

let client = HttpClient::new("https://api.usesynth.ai", "sk_live_...", 30)?;
let result: Value = client.get("/api/v1/jobs", None).await?;

Implementations§

Source§

impl HttpClient

Source

pub fn new( base_url: &str, api_key: &str, timeout_secs: u64, ) -> Result<Self, HttpError>

Create a new HTTP client.

§Arguments
  • base_url - Base URL for the API (without trailing slash)
  • api_key - API key for Bearer authentication
  • timeout_secs - Request timeout in seconds
§Environment Variables

Optional headers from environment:

  • SYNTH_USER_ID or X_USER_IDX-User-ID header
  • SYNTH_ORG_ID or X_ORG_IDX-Org-ID header
Source

pub async fn get<T: DeserializeOwned>( &self, path: &str, params: Option<&[(&str, &str)]>, ) -> Result<T, HttpError>

Make a GET request.

§Arguments
  • path - API path (relative or absolute)
  • params - Optional query parameters
Source

pub async fn get_bytes( &self, path: &str, params: Option<&[(&str, &str)]>, ) -> Result<Vec<u8>, HttpError>

Make a GET request and return raw bytes.

Source

pub async fn get_json( &self, path: &str, params: Option<&[(&str, &str)]>, ) -> Result<Value, HttpError>

Make a GET request returning raw JSON Value.

Source

pub async fn post_json<T: DeserializeOwned>( &self, path: &str, body: &Value, ) -> Result<T, HttpError>

Make a POST request with JSON body.

§Arguments
  • path - API path
  • body - JSON body to send
Source

pub async fn post_json_with_headers<T: DeserializeOwned>( &self, path: &str, body: &Value, extra_headers: Option<HeaderMap>, ) -> Result<T, HttpError>

Make a POST request with JSON body and extra headers.

Source

pub async fn post_multipart<T: DeserializeOwned>( &self, path: &str, data: &[(String, String)], files: &[MultipartFile], ) -> Result<T, HttpError>

Make a POST request with multipart form data.

§Arguments
  • path - API path
  • data - Form fields
  • files - File parts
Source

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

Make a DELETE request.

§Arguments
  • path - API path

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,