Struct DevToolsRemote

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

Handle to a detached loopback JSONL server and its UI-thread command queue.

Server/event and command channels are unbounded. The detached server thread polls at approximately 60 Hz, accepts at most eight clients, and terminates only when the process exits or the listener becomes permanently unusable.

§Examples

use std::net::SocketAddr;
use ailloli_ui_winit::devtools::DevToolsRemote;
let addr: SocketAddr = "127.0.0.1:9229".parse().unwrap();
let remote: Option<DevToolsRemote> = DevToolsRemote::start(addr);

Implementations§

Source§

impl DevToolsRemote

Environment startup, explicit loopback startup, and channel drains.

Source

pub fn from_env() -> Option<Self>

Starts the configured loopback remote, if the environment value is valid.

AILLOLI_UI_DEVTOOLS_REMOTE wins over the legacy variable. Empty, non-Unicode, malformed, non-loopback, unbindable, or nonblocking setup failures return None.

§Examples
let loader: fn() -> Option<ailloli_ui_winit::devtools::DevToolsRemote> =
    ailloli_ui_winit::devtools::DevToolsRemote::from_env;
let _ = loader;
Source

pub fn start(addr: SocketAddr) -> Option<Self>

Binds a nonblocking loopback TCP listener and detaches its server thread.

Non-loopback addresses are refused even if locally bindable. Port zero is accepted by the OS, but this handle does not expose the selected port. Any bind or nonblocking-configuration failure returns None.

§Examples
use std::net::SocketAddr;
let address: SocketAddr = "127.0.0.1:9229".parse().unwrap();
let remote = ailloli_ui_winit::devtools::DevToolsRemote::start(address);
let _ = remote;
Source

pub fn publish_snapshot(&self, snapshot: DebugSnapshot)

Queues a complete debug snapshot for best-effort broadcast to all clients.

The unbounded channel preserves order. If the detached server has ended, the snapshot is silently dropped.

§Examples
fn publish(remote: &ailloli_ui_winit::devtools::DevToolsRemote,
    snapshot: ailloli_ui_devtools_core::DebugSnapshot) {
    remote.publish_snapshot(snapshot);
}
Source

pub fn drain_commands(&self) -> Vec<DevToolsClientMessage>

Drains every currently queued client command in FIFO order.

Each drained command decrements the atomic pending count. Commands that arrive concurrently after try_recv observes empty wait for later service.

§Examples
fn drain(remote: &ailloli_ui_winit::devtools::DevToolsRemote) {
    let commands: Vec<ailloli_ui_devtools_core::DevToolsClientMessage> =
        remote.drain_commands();
    let _ = commands;
}

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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 = 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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,