netsock 0.7.0

Cross-platform library for network sockets information
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use bitflags::bitflags;

bitflags! {
    #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
    /// Flags representing different address families for network operations.
    ///
    /// This structure uses the `bitflags` macro to create a set of flags that can be combined
    /// using bitwise OR (`|`) to represent multiple address families simultaneously. It is
    /// typically used to specify preferences or capabilities related to IPv4 and IPv6 addresses
    /// in network operations.
    ///
    /// # Flags
    /// - `IPV4`: Represents the IPv4 address family. When set, this flag indicates that an operation
    ///   should consider or is capable of handling IPv4 addresses.
    /// - `IPV6`: Represents the IPv6 address family. When set, this flag signifies that an operation
    ///   should consider or is capable of handling IPv6 addresses.
    ///
    /// These flags can be combined to indicate support for both IPv4 and IPv6, or checked individually
    /// to determine the supported address families.
    ///
    /// # Examples
    /// ```
    /// use netsock::family::AddressFamilyFlags;
    ///
    /// // Specify that an operation supports both IPv4 and IPv6 addresses.
    /// let flags = AddressFamilyFlags::IPV4 | AddressFamilyFlags::IPV6;
    ///
    /// // Check if IPv4 is supported.
    /// assert!(flags.contains(AddressFamilyFlags::IPV4));
    /// assert!(flags.contains(AddressFamilyFlags::IPV6));
    /// ```
    pub struct AddressFamilyFlags: u8 {
        const IPV4 = 0b00000001;
        const IPV6 = 0b00000010;
    }
}