Skip to main content

Router

Struct Router 

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

A running router instance.

Implementations§

Source§

impl Router

Source

pub fn start(config: &RouterConfig) -> Result<Self>

Builds and starts a router from config (byte-only — no type shapes).

§Errors

RoutingError on validation failure, an unresolved type name, an unsupported option, or a DDS runtime error.

Source

pub fn start_with_types( config: &RouterConfig, shapes: TypeRegistry, ) -> Result<Self>

Like start but with a TypeRegistry supplying the type shapes content filtering and field transformation need. Routes without a filter/transform forward bytes verbatim and ignore the registry; routes with a filter/transform require their input and output types to be present.

§Errors

RoutingError as for start, plus a missing type shape for a filtering/transforming route.

Source

pub fn name(&self) -> &str

Router instance name.

Source

pub fn route_names(&self) -> Vec<String>

Names of the active routes.

Source

pub fn route_metrics(&self, route: &str) -> Option<RouteMetricsSnapshot>

Metrics snapshot for a route, or None if no such route.

Source

pub fn shutdown(&mut self)

Stops all pumps and tears the router down.

Trait Implementations§

Source§

impl Drop for Router

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.