Skip to main content

ApiRouter

Struct ApiRouter 

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

Minimal cloneable router for one command endpoint and multiple query endpoints.

Clones share an immutable endpoint snapshot. Runtime hosts freeze query registration after bootstrap and clone the router before dispatch so no host-state lock is retained while an endpoint executes.

Implementations§

Source§

impl ApiRouter

Source

pub fn new() -> Self

Creates an empty transport-neutral router.

Source

pub fn set_command_endpoint<E: CommandEndpoint + 'static>( &mut self, endpoint: E, )

Replaces the command endpoint used by this router.

Source

pub fn register_query<E: QueryEndpoint + 'static>( &mut self, endpoint: E, ) -> RuntimeResult<()>

Registers one uniquely named application query endpoint.

Registration fails after Self::freeze_queries.

Source

pub fn freeze_queries(&mut self)

Freezes application query registration while preserving dispatch.

Source

pub fn queries_are_frozen(&self) -> bool

Reports whether application query registration is frozen.

Source

pub fn has_query(&self, name: &QueryName) -> bool

Reports whether a query endpoint is registered.

Source

pub fn query_names(&self) -> Vec<QueryName>

Returns registered query names in deterministic lexical order.

Source

pub fn query_names_iter(&self) -> impl ExactSizeIterator<Item = &QueryName>

Iterates over registered query names without cloning or ordering them.

Callers that expose names externally must impose their required stable order. Validation paths can scan this view without materializing the complete registry.

Source

pub fn dispatch_query( &self, name: &QueryName, request: ApiRequest, ) -> RuntimeResult<ApiResponse>

Dispatches a request to a named query endpoint.

Source

pub fn dispatch_command( &self, request: ApiRequest, ) -> RuntimeResult<ApiResponse>

Dispatches a request to the configured command endpoint.

Trait Implementations§

Source§

impl Clone for ApiRouter

Source§

fn clone(&self) -> ApiRouter

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 Default for ApiRouter

Source§

fn default() -> ApiRouter

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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