Skip to main content

StatusResponse

Struct StatusResponse 

Source
pub struct StatusResponse {
    pub connection_id: Option<String>,
    pub control_host: String,
    pub control_port: i32,
    pub daemon_url: String,
    pub debug_port: i32,
    pub debug_port_active: bool,
    pub name: String,
    pub state: ClientState,
}
Expand description

Current client status

JSON schema
{
 "description": "Current client status",
 "type": "object",
 "required": [
   "control_host",
   "control_port",
   "daemon_url",
   "debug_port",
   "debug_port_active",
   "name",
   "state"
 ],
 "properties": {
   "connection_id": {
     "description": "Connection ID assigned by the daemon upon registration.\nNull if not currently registered (state is \"sleeping\").\n",
     "type": "string",
     "example": "conn_abc123",
     "nullable": true
   },
   "control_host": {
     "description": "Host the control plane is bound to",
     "type": "string",
     "example": "127.0.0.1"
   },
   "control_port": {
     "description": "Actual port the control plane is listening on.\n0 if the control plane has not been started yet.\n",
     "type": "integer",
     "format": "int32",
     "maximum": 65535.0,
     "minimum": 0.0,
     "example": 8091
   },
   "daemon_url": {
     "description": "URL of the Detrix daemon this client connects to",
     "type": "string",
     "example": "http://127.0.0.1:8090"
   },
   "debug_port": {
     "description": "Debug adapter port. 0 if debugger has never been started.\nMay be non-zero even when sleeping due to debugger limitations.\n",
     "type": "integer",
     "format": "int32",
     "maximum": 65535.0,
     "minimum": 0.0,
     "example": 5678
   },
   "debug_port_active": {
     "description": "True if the debug port is actually open and accepting connections.\nThis may be true even when state is \"sleeping\" because some debuggers\n(e.g., debugpy) cannot stop their listener once started.\n",
     "type": "boolean",
     "example": true
   },
   "name": {
     "description": "Connection name for this client",
     "type": "string",
     "example": "my-service-12345"
   },
   "state": {
     "$ref": "#/components/schemas/ClientState"
   }
 },
 "example": {
   "connection_id": "conn_abc123",
   "control_host": "127.0.0.1",
   "control_port": 8091,
   "daemon_url": "http://127.0.0.1:8090",
   "debug_port": 5678,
   "debug_port_active": true,
   "name": "my-service-12345",
   "state": "awake"
 }
}

Fields§

§connection_id: Option<String>

Connection ID assigned by the daemon upon registration. Null if not currently registered (state is “sleeping”).

§control_host: String

Host the control plane is bound to

§control_port: i32

Actual port the control plane is listening on. 0 if the control plane has not been started yet.

§daemon_url: String

URL of the Detrix daemon this client connects to

§debug_port: i32

Debug adapter port. 0 if debugger has never been started. May be non-zero even when sleeping due to debugger limitations.

§debug_port_active: bool

True if the debug port is actually open and accepting connections. This may be true even when state is “sleeping” because some debuggers (e.g., debugpy) cannot stop their listener once started.

§name: String

Connection name for this client

§state: ClientState

Trait Implementations§

Source§

impl Clone for StatusResponse

Source§

fn clone(&self) -> StatusResponse

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 StatusResponse

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for StatusResponse

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&StatusResponse> for StatusResponse

Source§

fn from(value: &StatusResponse) -> Self

Converts to this type from the input type.
Source§

impl Serialize for StatusResponse

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,