Struct spirit_tokio::net::limits::WithListenLimits

pub struct WithListenLimits<Listener, Limits> {
    pub listener: Listener,
    // some fields omitted
}

A wrapper around a listening socket Fragment that adds limits and error handling to it.

There's also the convenience type alias WithLimits.

Note that the applied limits are per-instance. If there are two sockets in eg Vec<TcpListenWithLimits>, their limits are independent. In addition, if a configuration of a socket changes, the old listening socket is destroyed but the old connections are kept around until they terminate. The new listening socket starts with fresh limits, not counting the old connections.

Fields

listener: Listener

The inner listener socket.

This is available publicly to allow reading the extra configuration out of it.

Trait Implementations

impl<Listener: Clone, Limits: Clone> Clone for WithListenLimits<Listener, Limits>

fn clone(&self) -> WithListenLimits<Listener, Limits>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Listener: PartialEq, Limits: PartialEq> PartialEq<WithListenLimits<Listener, Limits>> for WithListenLimits<Listener, Limits>

fn eq(&self, other: &WithListenLimits<Listener, Limits>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WithListenLimits<Listener, Limits>) -> bool

This method tests for !=.

impl<Listener: PartialOrd, Limits: PartialOrd> PartialOrd<WithListenLimits<Listener, Limits>> for WithListenLimits<Listener, Limits>

fn partial_cmp(
    &self,
    other: &WithListenLimits<Listener, Limits>
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &WithListenLimits<Listener, Limits>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &WithListenLimits<Listener, Limits>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &WithListenLimits<Listener, Limits>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &WithListenLimits<Listener, Limits>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Listener: Ord, Limits: Ord> Ord for WithListenLimits<Listener, Limits>

fn cmp(&self, other: &WithListenLimits<Listener, Limits>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl<Listener: Eq, Limits: Eq> Eq for WithListenLimits<Listener, Limits>

impl<Listener: Default, Limits: Default> Default for WithListenLimits<Listener, Limits>

fn default() -> WithListenLimits<Listener, Limits>

Returns the "default value" for a type.

impl<Listener: Hash, Limits: Hash> Hash for WithListenLimits<Listener, Limits>

fn hash<__HListenerLimits: Hasher>(&self, state: &mut __HListenerLimits)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<Listener: Debug, Limits: Debug> Debug for WithListenLimits<Listener, Limits>

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

Formats the value using the given formatter.

impl<Listener, Limits> Serialize for WithListenLimits<Listener, Limits> where
    Listener: Serialize,
    Limits: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, Listener, Limits> Deserialize<'de> for WithListenLimits<Listener, Limits> where
    Listener: Deserialize<'de>,
    Limits: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<Listener, Limits> Comparable<WithListenLimits<Listener, Limits>> for WithListenLimits<Listener, Limits> where
    Listener: Comparable,
    Limits: PartialEq, 

fn compare(&self, other: &Self) -> Comparison

Compares two fragments.

impl<Listener, Limits> Fragment for WithListenLimits<Listener, Limits> where
    Listener: Clone + Debug + Fragment + Comparable,
    Limits: Clone + Debug + ListenLimits + PartialEq, 

type Driver = CacheSimilar<Self>

The default driver to be used by the fragment.

type Installer = ()

The default installer to be used unless a transformation or the user doesn't provide one.

type Seed = Listener::Seed

The intermediate product if the fragment supports two-stage creation of [Resource][Fragment::Resource]s. If not, it can be set to ().

type Resource = LimitedListener<Listener::Resource>

The actual product this [Fragment] creates.

const RUN_BEFORE_CONFIG: bool

Configuration if the pipeline should be run once even before the config is loaded.

fn make_seed(&self, name: &'static str) -> Result<Self::Seed, Error>

Runs the first stage of creation.

fn make_resource(
    &self,
    seed: &mut Self::Seed,
    name: &'static str
) -> Result<Self::Resource, Error>

Runs the second stage of creation.

fn init<B: Extensible<Ok = B>>(
    builder: B,
    name: &'static str
) -> Result<B, Error> where
    B::Config: DeserializeOwned + Send + Sync + 'static,
    B::Opts: StructOpt + Send + Sync + 'static, 

An initialization routine.

fn create(&self, name: &'static str) -> Result<Self::Resource, Error>

Runs both stages of creation at once.

impl<Listener, Limits> Stackable for WithListenLimits<Listener, Limits> where
    Listener: Stackable, 

impl<Listener, Limits> StructDoc for WithListenLimits<Listener, Limits> where
    Listener: StructDoc,
    Limits: StructDoc, 

fn document() -> Documentation

Returns the documentation for the type.