Struct spirit_tokio::net::TcpListen

#[non_exhaustive]
pub struct TcpListen<ExtraCfg = Empty, TcpStreamConfigure = TcpConfig> {
    pub listen: Listen,
    pub tcp_config: TcpStreamConfigure,
    pub extra_cfg: ExtraCfg,
}

A configuration fragment of a TCP listening socket.

The Fragment creates a TcpListener (wrapped in ConfiguredListener). It can be handled directly, or through Pipelines.

Note that this stream sometimes returns errors „in the middle“, but most stream consumers terminate on the first error. You might be interested in the WithListenLimits wrapper to handle that automatically (or, see the TcpListenWithLimits for a convenient type alias).

Type parametes

• ExtraCfg: Additional application specific configuration that can be extracted and used by the application code. This doesn’t influence the socket created in any way.
• TcpStreamConfigure: Further configuration for the accepted TCP streams in the form of StreamConfig

Fields

The configuration fields are pooled from all three type parameters above and from the Listen configuration fragment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

listen: Listen

The actual listener socket address.

tcp_config: TcpStreamConfigure

Configuration to be applied to the accepted connections.

extra_cfg: ExtraCfg

Arbitrary application specific configuration that doesn’t influence the sockets created.

Trait Implementations

impl<ExtraCfg: Clone, TcpStreamConfigure: Clone> Clone for TcpListen<ExtraCfg, TcpStreamConfigure>

fn clone(&self) -> TcpListen<ExtraCfg, TcpStreamConfigure>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ExtraCfg: PartialEq, TcpConfig: PartialEq> Comparable<TcpListen<ExtraCfg, TcpConfig>> for TcpListen<ExtraCfg, TcpConfig>

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

Compares two fragments.

impl<ExtraCfg: Debug, TcpStreamConfigure: Debug> Debug for TcpListen<ExtraCfg, TcpStreamConfigure>

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

Formats the value using the given formatter.

impl<ExtraCfg: Default, TcpStreamConfigure: Default> Default for TcpListen<ExtraCfg, TcpStreamConfigure>

fn default() -> TcpListen<ExtraCfg, TcpStreamConfigure>

Returns the “default value” for a type.

impl<'de, ExtraCfg, TcpStreamConfigure> Deserialize<'de> for TcpListen<ExtraCfg, TcpStreamConfigure> where
    ExtraCfg: Deserialize<'de>,
    TcpStreamConfigure: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<ExtraCfg, TcpConfig> Fragment for TcpListen<ExtraCfg, TcpConfig> where
    ExtraCfg: Clone + Debug + PartialEq,
    TcpConfig: Clone + Debug + 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 = StdTcpListener

The intermediate product if the fragment supports two-stage creation of Resources. If not, it can be set to ().

type Resource = ConfiguredListener<TcpListener, TcpConfig>

The actual product this Fragment creates.

fn make_seed(&self, name: &str) -> Result<StdTcpListener, AnyError>

Runs the first stage of creation.

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

Runs the second stage of creation.

const RUN_BEFORE_CONFIG: bool

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

fn create(
    &self,
    name: &'static str
) -> Result<Self::Resource, Box<dyn Error + Send + Sync + 'static, Global>>

Runs both stages of creation at once.

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

An initialization routine.

impl<ExtraCfg: Hash, TcpStreamConfigure: Hash> Hash for TcpListen<ExtraCfg, TcpStreamConfigure>

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

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<ExtraCfg: Ord, TcpStreamConfigure: Ord> Ord for TcpListen<ExtraCfg, TcpStreamConfigure>

fn cmp(&self, other: &TcpListen<ExtraCfg, TcpStreamConfigure>) -> 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

Restrict a value to a certain interval.

impl<ExtraCfg: PartialEq, TcpStreamConfigure: PartialEq> PartialEq<TcpListen<ExtraCfg, TcpStreamConfigure>> for TcpListen<ExtraCfg, TcpStreamConfigure>

fn eq(&self, other: &TcpListen<ExtraCfg, TcpStreamConfigure>) -> bool

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

fn ne(&self, other: &TcpListen<ExtraCfg, TcpStreamConfigure>) -> bool

This method tests for !=.

impl<ExtraCfg: PartialOrd, TcpStreamConfigure: PartialOrd> PartialOrd<TcpListen<ExtraCfg, TcpStreamConfigure>> for TcpListen<ExtraCfg, TcpStreamConfigure>

fn partial_cmp(
    &self,
    other: &TcpListen<ExtraCfg, TcpStreamConfigure>
) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl<ExtraCfg, TcpStreamConfigure> Serialize for TcpListen<ExtraCfg, TcpStreamConfigure> where
    ExtraCfg: Serialize,
    TcpStreamConfigure: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<ExtraCfg, TcpStreamConfigure> StructDoc for TcpListen<ExtraCfg, TcpStreamConfigure> where
    ExtraCfg: StructDoc,
    TcpStreamConfigure: StructDoc, 

fn document() -> Documentation

Returns the documentation for the type.

impl<ExtraCfg: Eq, TcpStreamConfigure: Eq> Eq for TcpListen<ExtraCfg, TcpStreamConfigure>

impl<ExtraCfg, TcpConfig> Stackable for TcpListen<ExtraCfg, TcpConfig>

impl<ExtraCfg, TcpStreamConfigure> StructuralEq for TcpListen<ExtraCfg, TcpStreamConfigure>

impl<ExtraCfg, TcpStreamConfigure> StructuralPartialEq for TcpListen<ExtraCfg, TcpStreamConfigure>