Struct spirit_tokio::net::UdpListen

#[non_exhaustive]pub struct UdpListen<ExtraCfg = Empty> {
    pub listen: Listen,
    pub extra_cfg: ExtraCfg,
}

A configuration fragment describing a bound UDP socket.

This is similar to TcpListen, but for UDP sockets.

Type parameters

• ExtraCfg: Extra options folded into this configuration, for application specific options. They don't influence the socket in any way.

Configuration options

In addition to options provided by the above type parameters, the options from Listen are prestent.

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

Configuration for the address to bind to.

extra_cfg: ExtraCfg

Arbitrary application specific configuration that doesn't influence the created socket, but can be examined in the handlers.

Trait Implementations

impl<ExtraCfg: Clone> Clone for UdpListen<ExtraCfg>

fn clone(&self) -> UdpListen<ExtraCfg>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ExtraCfg: PartialEq> Comparable<UdpListen<ExtraCfg>> for UdpListen<ExtraCfg>

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

Compares two fragments.

impl<ExtraCfg: Debug> Debug for UdpListen<ExtraCfg>

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

Formats the value using the given formatter.

impl<ExtraCfg: Default> Default for UdpListen<ExtraCfg>

fn default() -> UdpListen<ExtraCfg>

Returns the "default value" for a type.

impl<'de, ExtraCfg> Deserialize<'de> for UdpListen<ExtraCfg> where
    ExtraCfg: 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: Eq> Eq for UdpListen<ExtraCfg>

impl<ExtraCfg> Fragment for UdpListen<ExtraCfg> where
    ExtraCfg: 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 = StdUdpSocket

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

type Resource = UdpSocket

The actual product this Fragment creates.

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

Runs the first stage of creation.

fn make_resource(
    &self,
    seed: &mut Self::Seed,
    name: &str
) -> Result<UdpSocket, 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 + 'static + Sync + Send>>

Runs both stages of creation at once.

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

An initialization routine.

impl<ExtraCfg: Hash> Hash for UdpListen<ExtraCfg>

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> Ord for UdpListen<ExtraCfg>

fn cmp(&self, other: &UdpListen<ExtraCfg>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<ExtraCfg: PartialEq> PartialEq<UdpListen<ExtraCfg>> for UdpListen<ExtraCfg>

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

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

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

This method tests for !=.

impl<ExtraCfg: PartialOrd> PartialOrd<UdpListen<ExtraCfg>> for UdpListen<ExtraCfg>

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

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

fn lt(&self, other: &UdpListen<ExtraCfg>) -> bool

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

fn le(&self, other: &UdpListen<ExtraCfg>) -> bool

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

fn gt(&self, other: &UdpListen<ExtraCfg>) -> bool

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

fn ge(&self, other: &UdpListen<ExtraCfg>) -> bool

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

impl<ExtraCfg> Serialize for UdpListen<ExtraCfg> where
    ExtraCfg: 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> Stackable for UdpListen<ExtraCfg>

impl<ExtraCfg> StructDoc for UdpListen<ExtraCfg> where
    ExtraCfg: StructDoc, 

fn document() -> Documentation

Returns the documentation for the type.

impl<ExtraCfg> StructuralEq for UdpListen<ExtraCfg>

impl<ExtraCfg> StructuralPartialEq for UdpListen<ExtraCfg>