Skip to main content

HttpClient

Struct HttpClient 

Source
pub struct HttpClient {
    pub http_client: Client,
    pub api_base: String,
    pub api_key: Option<String>,
    pub user_agent: Option<String>,
    pub x_title: Option<String>,
    pub referer: Option<String>,
}
Expand description

HTTP client for making requests to the ObjectiveAI API.

Handles authentication, request building, and response parsing for both unary and streaming endpoints.

§Example

let client = HttpClient::new(
    reqwest::Client::new(),
    None, // Use default API base
    Some("your-api-key"),
    None, // user_agent
    None, // x_title
    None, // referer
);

Fields§

§http_client: Client

The underlying reqwest HTTP client.

§api_base: String

Base URL for API requests. Defaults to https://api.objective-ai.io.

§api_key: Option<String>

API key for authentication. Sent as Bearer token in Authorization header.

§user_agent: Option<String>

Value for the User-Agent header.

§x_title: Option<String>

Value for the X-Title header.

§referer: Option<String>

Value for both Referer and HTTP-Referer headers.

Implementations§

Source§

impl HttpClient

Source

pub fn new( http_client: Client, api_base: Option<impl Into<String>>, api_key: Option<impl Into<String>>, user_agent: Option<impl Into<String>>, x_title: Option<impl Into<String>>, referer: Option<impl Into<String>>, ) -> Self

Creates a new HTTP client.

§Arguments
  • http_client - The reqwest client to use for requests
  • api_base - Base URL for API requests (defaults to https://api.objective-ai.io)
  • api_key - API key for authentication
  • user_agent - Optional User-Agent header value
  • x_title - Optional X-Title header value
  • referer - Optional Referer header value
Source

pub async fn send_unary<T: DeserializeOwned + Send + 'static>( &self, method: Method, path: impl AsRef<str>, body: Option<impl Serialize>, ) -> Result<T, HttpError>

Sends a unary (request-response) API call and deserializes the response.

§Type Parameters
  • T - The expected response type to deserialize into
§Arguments
  • method - HTTP method (GET, POST, etc.)
  • path - API endpoint path (will be appended to api_base)
  • body - Optional request body to serialize as JSON
§Errors

Returns super::HttpError if the request fails, returns a non-success status, or the response cannot be deserialized.

Source

pub async fn send_unary_no_response( &self, method: Method, path: impl AsRef<str>, body: Option<impl Serialize>, ) -> Result<(), HttpError>

Sends a unary API call that expects no response body.

Useful for DELETE or other operations that only return a status code.

§Arguments
  • method - HTTP method (GET, POST, DELETE, etc.)
  • path - API endpoint path (will be appended to api_base)
  • body - Optional request body to serialize as JSON
§Errors

Returns super::HttpError if the request fails or returns a non-success status.

Source

pub async fn send_streaming<T: DeserializeOwned + Send + 'static, P: AsRef<str> + Send, B: Serialize + Send>( &self, method: Method, path: P, body: Option<B>, ) -> Result<impl Stream<Item = Result<T, HttpError>> + Send + 'static + use<T, P, B>, HttpError>

Sends a streaming API call using Server-Sent Events (SSE).

Returns a stream of deserialized chunks. The stream automatically handles:

  • SSE [DONE] messages (filtered out)
  • Comment lines starting with : (filtered out)
  • Empty data lines (filtered out)
  • API errors embedded in stream data
§Type Parameters
  • T - The expected chunk type to deserialize each SSE message into
§Arguments
  • method - HTTP method (typically POST for streaming)
  • path - API endpoint path (will be appended to api_base)
  • body - Optional request body to serialize as JSON
§Errors

Returns super::HttpError if the stream cannot be established. Individual stream items may also contain errors if chunks fail to deserialize.

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

impl Debug for HttpClient

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