Skip to main content

CoderHttpClient

Struct CoderHttpClient 

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

The Coder-shaped HTTP client (production SubstrateClient): base URL + session token, Coder’s Coder-Session-Token auth header, one bounded timeout per call. Wire mapping (the documented v1 substrate shape — validated against a loopback mock only, no live Coder deployment):

  • create_workspacePOST {base}/api/v2/users/me/workspaces with body {"template_id", "name", "env_names"} (names only — the substrate injects the named secrets from its own store), plus "idle_after_hours" when workspace.remote.idleAfterHours is configured (the substrate owns the idle policy; a substrate without support ignores the key). Response: {"id", "urls"?, "takeover"?}urls/takeover optional so a stock Coder create response (which carries the id but not flattened app URLs) degrades honestly to “no previews reported.”
  • workspace_statusGET {base}/api/v2/workspaces/{id}; reads top-level status or latest_build.status: "running" → ready, "failed" → failed, anything else (starting/stopping/unknown) → pending (keep polling, bounded).
  • delete_workspace / stop_workspacePOST {base}/api/v2/workspaces/{id}/builds with {"transition": "delete" | "stop"} (Coder models both as workspace builds).

Implementations§

Source§

impl CoderHttpClient

Source

pub fn new(base_url: &str, token: &str) -> Result<Self>

Build the client, validating the base URL eagerly (fail closed at provision with the config key named, not mid-request).

Trait Implementations§

Source§

impl SubstrateClient for CoderHttpClient

Source§

fn create_workspace<'life0, 'life1, 'async_trait>( &'life0 self, spec: &'life1 SubstrateWorkspaceSpec, ) -> Pin<Box<dyn Future<Output = Result<SubstrateWorkspace>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create (and start) one workspace from a pinned template, injecting the named secrets — NAMES only, never values.
Source§

fn workspace_status<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<SubstrateStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The workspace’s current lifecycle state.
Source§

fn delete_workspace<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Release the workspace entirely (TeardownMode::Destroy).
Source§

fn stop_workspace<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Provider-owned idle suspension (TeardownMode::Hibernate).

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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