Struct tide_disco::listener::RateLimitListener

pub struct RateLimitListener<State> { /* private fields */ }

TCP listener which accepts only a limited number of connections at a time.

This listener is based on tide::listener::TcpListener and should match the semantics of that listener in every way, accept that when there are more simultaneous outstanding requests than the configured limit, excess requests will fail immediately with error code 429 (Too Many Requests).

Implementations

impl<State> RateLimitListener<State>

pub fn new(addr: SocketAddr, limit: usize) -> Self

Listen at the given address.

pub fn with_port(port: u16, limit: usize) -> Self

Listen at the given port on all interfaces.

Trait Implementations

impl<State> Debug for RateLimitListener<State>

where State: Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<State> Display for RateLimitListener<State>

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

Formats the value using the given formatter.

impl<State> Listener<State> for RateLimitListener<State>

where State: Clone + Send + Sync + 'static,

fn bind<'life0, 'async_trait>( &'life0 mut self, app: Server<State>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Bind the listener. This starts the listening process by opening the necessary network ports, but not yet accepting incoming connections. This method must be called before accept.

fn accept<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Start accepting incoming connections. This method must be called only after bind has succeeded.

fn info(&self) -> Vec<ListenInfo>

Expose information about the connection. This should always return valid data after bind has succeeded.

impl<State> ToListener<State> for RateLimitListener<State>

where State: Clone + Send + Sync + 'static,

type Listener = RateLimitListener<State>

What listener are we converting into?

fn to_listener(self) -> Result<Self::Listener>

Transform self into a Listener. Unless self is already bound/connected to the underlying io, converting to a listener does not initiate a connection. An Err return indicates an unsuccessful conversion to a listener, not an unsuccessful bind attempt.