Trait snocat::common::protocol::traits::Router

pub trait Router: Downcast + DowncastSync {
    fn route(
        &self, 
        request: &Request, 
        tunnel_registry: Arc<dyn TunnelRegistry + Send + Sync>
    ) -> BoxFuture<'_, Result<(RouteAddress, Box<dyn TunnelStream + Send + Sync + 'static>), RoutingError>>;
}

Routers are responsible for taking an address and forwarding it to the appropriate tunnel. When forwarding, the router can alter the address to remove any routing-specific information before it is handed to the Request’s protocol::Client.

Required methods

fn route(
    &self,
    request: &Request,
    tunnel_registry: Arc<dyn TunnelRegistry + Send + Sync>
) -> BoxFuture<'_, Result<(RouteAddress, Box<dyn TunnelStream + Send + Sync + 'static>), RoutingError>>

Implementations

impl dyn Router

pub fn is<__T: Router>(&self) -> bool

Returns true if the trait object wraps an object of type __T.

pub fn downcast<__T: Router>(self: Box<Self>) -> Result<Box<__T>, Box<Self>>

Returns a boxed object from a boxed trait object if the underlying object is of type __T. Returns the original boxed trait if it isn’t.

pub fn downcast_rc<__T: Router>(self: Rc<Self>) -> Result<Rc<__T>, Rc<Self>>

Returns an Rc-ed object from an Rc-ed trait object if the underlying object is of type __T. Returns the original Rc-ed trait if it isn’t.

pub fn downcast_ref<__T: Router>(&self) -> Option<&__T>

Returns a reference to the object within the trait object if it is of type __T, or None if it isn’t.

pub fn downcast_mut<__T: Router>(&mut self) -> Option<&mut __T>

Returns a mutable reference to the object within the trait object if it is of type __T, or None if it isn’t.

pub fn downcast_arc<__T: Router>(self: Arc<Self>) -> Result<Arc<__T>, Arc<Self>> where
    __T: Any + Send + Sync, 

Returns an Arc-ed object from an Arc-ed trait object if the underlying object is of type __T. Returns the original Arc-ed trait if it isn’t.

Implementors