Struct spirit_tokio::net::unix::Listen

#[non_exhaustive]pub struct Listen {
    pub path: PathBuf,
}

Configuration of where to bind a unix domain socket.

This is the lower-level configuration fragment that doesn't directly provide much functionality. But it is the basic building block of both UnixListen and UnixDatagram.

Note that this does provide the Default trait, but the default value is mostly useless.

Configuration options

• path: The filesystem path to bind the socket to.

TODO

• Setting permissions on the newly bound socket.
• Ability to remove previous socket:
  • In case it is a dead socket (leftover, but nobody listens on it).
  • It is any socket.
  • Always.

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.

path: PathBuf

The path on the FS where to create the unix domain socket.

Implementations

impl Listen

pub fn create_listener(&self) -> Result<StdUnixListener, AnyError>

Creates a unix listener.

This is a low-level function, returning the blocking (std) listener.

pub fn create_datagram(&self) -> Result<StdUnixDatagram, AnyError>

Creates a unix datagram socket.

This is a low-level function, returning the blocking (std) socket.

Trait Implementations

impl Clone for Listen

fn clone(&self) -> Listen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Listen

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

Formats the value using the given formatter.

impl Default for Listen

fn default() -> Listen

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Listen

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

Deserialize this value from the given Serde deserializer.

impl Eq for Listen

impl Hash for Listen

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 Ord for Listen

fn cmp(&self, other: &Listen) -> 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 PartialEq<Listen> for Listen

fn eq(&self, other: &Listen) -> bool

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

fn ne(&self, other: &Listen) -> bool

This method tests for !=.

impl PartialOrd<Listen> for Listen

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

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

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

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

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

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

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

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

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

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

impl Serialize for Listen

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

Serialize this value into the given Serde serializer.

impl StructDoc for Listen

fn document() -> Documentation

Returns the documentation for the type.

impl StructuralEq for Listen

impl StructuralPartialEq for Listen