Skip to main content

HttpTransport

Struct HttpTransport 

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

Low-level JSON-over-HTTP transport bound to one opencode base URL.

Cloning is cheap: the inner reqwest::Client is reference-counted.

Implementations§

Source§

impl HttpTransport

Source

pub fn new( client: Client, base_url: impl Into<String>, timeout: Option<Duration>, auth: Option<BasicAuth>, scope: Scope, ) -> Self

Bind a transport to a base URL.

Trailing slashes on base_url are stripped so path builders can append /-prefixed segments without producing //. The URL itself is validated lazily by reqwest at send time; a malformed base surfaces as Error::Transport.

Source

pub fn base_url(&self) -> &str

The normalized base URL (no trailing slash).

Source

pub fn auth(&self) -> Option<&BasicAuth>

Credentials attached to every request, if any.

Source

pub fn scope(&self) -> &Scope

The directory / workspace scoping applied to every session URL and the GET /event stream this transport builds.

Source

pub fn join(&self, path: &str) -> String

Join an arbitrary path (leading slash optional) onto the base URL. Backing helper for the client’s raw escape hatch; the path is used verbatim (not segment-encoded).

Source

pub fn session_create_url(&self) -> String

URL for POST /session (session creation).

Source

pub fn prompt_async_url(&self, session_id: &str) -> String

URL for POST /session/{sessionID}/prompt_async.

Source

pub fn messages_url( &self, session_id: &str, limit: Option<u64>, before: Option<&str>, ) -> String

URL for GET /session/{sessionID}/message, optionally paginated with the limit and before query parameters used for reconciliation polling.

Source

pub fn abort_url(&self, session_id: &str) -> String

URL for POST /session/{sessionID}/abort.

Source

pub fn permission_url(&self, session_id: &str, permission_id: &str) -> String

URL for POST /session/{sessionID}/permissions/{permissionID}.

Source

pub fn event_url(&self) -> String

URL for the GET /event SSE stream, with any configured Scope applied as directory / workspace query parameters.

Source

pub fn event_request(&self) -> RequestBuilder

A RequestBuilder for the GET /event SSE stream on this transport’s Client, with the configured base URL, Scope, and auth applied.

Hand it to crate::sse::EventStream::from_request to open an authenticated event stream that reuses this transport’s connection pool. No per-request timeout is applied, since the stream is long-lived.

Source

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

Send a request and deserialize the JSON response body into R.

Source

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

Send a request that yields no response body (e.g. an HTTP 204), discarding the body on success.

Trait Implementations§

Source§

impl Clone for HttpTransport

Source§

fn clone(&self) -> HttpTransport

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

impl Debug for HttpTransport

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