# lib.rs - source
Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/socket2-0.4.0/src/lib.rs`.
Keywords: rust, rustlang, rust-lang

      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
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399

    // Copyright 2015 The Rust Project Developers.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Utilities for creating and using sockets.
    //!
    //! The goal of this crate is to create and use a socket using advanced
    //! configuration options (those that are not available in the types in the
    //! standard library) without using any unsafe code.
    //!
    //! This crate provides as direct as possible access to the system's
    //! functionality for sockets, this means little effort to provide
    //! cross-platform utilities. It is up to the user to know how to use sockets
    //! when using this crate. *If you don't know how to create a socket using
    //! libc/system calls then this crate is not for you*. Most, if not all,
    //! functions directly relate to the equivalent system call with no error
    //! handling applied, so no handling errors such as [`EINTR`]. As a result using
    //! this crate can be a little wordy, but it should give you maximal flexibility
    //! over configuration of sockets.
    //!
    //! [`EINTR`]: std::io::ErrorKind::Interrupted
    //!
    //! # Examples
    //!
    //! ```no_run
    //! # fn main() -> std::io::Result<()> {
    //! use std::net::{SocketAddr, TcpListener};
    //! use socket2::{Socket, Domain, Type};
    //!
    //! // Create a TCP listener bound to two addresses.
    //! let socket = Socket::new(Domain::IPV6, Type::STREAM, None)?;
    //!
    //! let address: SocketAddr = "[::1]:12345".parse().unwrap();
    //! socket.bind(&address.into())?;
    //! socket.set_only_v6(false)?;
    //! socket.listen(128)?;
    //!
    //! let listener: TcpListener = socket.into();
    //! // ...
    //! # drop(listener);
    //! # Ok(()) }
    //! ```
    //!
    //! ## Features
    //!
    //! This crate has a single feature `all`, which enables all functions even ones
    //! that are not available on all OSs.

    #![doc(html_root_url = "https://docs.rs/socket2/0.3")]
    #![deny(missing_docs, missing_debug_implementations, rust_2018_idioms)]
    // Show required OS/features on docs.rs.
    #![cfg_attr(docsrs, feature(doc_cfg))]
    // Disallow warnings when running tests.
    #![cfg_attr(test, deny(warnings))]
    // Disallow warnings in examples.
    #![doc(test(attr(deny(warnings))))]

    use std::fmt;
    use std::mem::MaybeUninit;
    use std::net::SocketAddr;
    use std::ops::{Deref, DerefMut};
    use std::time::Duration;

    /// Macro to implement `fmt::Debug` for a type, printing the constant names
    /// rather than a number.
    ///
    /// Note this is used in the `sys` module and thus must be defined before
    /// defining the modules.
    macro_rules! impl_debug {
        (
            // Type name for which to implement `fmt::Debug`.
            $type: path,
            $(
                $(#[$target: meta])*
                // The flag(s) to check.
                // Need to specific the libc crate because Windows doesn't use
                // `libc` but `winapi`.
                $libc: ident :: $flag: ident
            ),+ $(,)*
        ) => {
            impl std::fmt::Debug for $type {
                fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                    let string = match self.0 {
                        $(
                            $(#[$target])*
                            $libc :: $flag => stringify!($flag),
                        )+
                        n => return write!(f, "{}", n),
                    };
                    f.write_str(string)
                }
            }
        };
    }

    /// Macro to convert from one network type to another.
    macro_rules! from {
        ($from: ty, $for: ty) => {
            impl From<$from> for $for {
                fn from(socket: $from) -> $for {
                    #[cfg(unix)]
                    unsafe {
                        <$for>::from_raw_fd(socket.into_raw_fd())
                    }
                    #[cfg(windows)]
                    unsafe {
                        <$for>::from_raw_socket(socket.into_raw_socket())
                    }
                }
            }
        };
    }

    mod sockaddr;
    mod socket;
    mod sockref;

    #[cfg(unix)]
    #[path = "sys/unix.rs"]
    mod sys;
    #[cfg(windows)]
    #[path = "sys/windows.rs"]
    mod sys;

    use sys::c_int;

    pub use sockaddr::SockAddr;
    pub use socket::Socket;
    pub use sockref::SockRef;

    /// Specification of the communication domain for a socket.
    ///
    /// This is a newtype wrapper around an integer which provides a nicer API in
    /// addition to an injection point for documentation. Convenience constants such
    /// as [`Domain::IPV4`], [`Domain::IPV6`], etc, are provided to avoid reaching
    /// into libc for various constants.
    ///
    /// This type is freely interconvertible with C's `int` type, however, if a raw
    /// value needs to be provided.
    #[derive(Copy, Clone, Eq, PartialEq)]
    pub struct Domain(c_int);

    impl Domain {
        /// Domain for IPv4 communication, corresponding to `AF_INET`.
        pub const IPV4: Domain = Domain(sys::AF_INET);

        /// Domain for IPv6 communication, corresponding to `AF_INET6`.
        pub const IPV6: Domain = Domain(sys::AF_INET6);

        /// Returns the correct domain for `address`.
        pub const fn for_address(address: SocketAddr) -> Domain {
            match address {
                SocketAddr::V4(_) => Domain::IPV4,
                SocketAddr::V6(_) => Domain::IPV6,
            }
        }
    }

    impl From<c_int> for Domain {
        fn from(d: c_int) -> Domain {
            Domain(d)
        }
    }

    impl From<Domain> for c_int {
        fn from(d: Domain) -> c_int {
            d.0
        }
    }

    /// Specification of communication semantics on a socket.
    ///
    /// This is a newtype wrapper around an integer which provides a nicer API in
    /// addition to an injection point for documentation. Convenience constants such
    /// as [`Type::STREAM`], [`Type::DGRAM`], etc, are provided to avoid reaching
    /// into libc for various constants.
    ///
    /// This type is freely interconvertible with C's `int` type, however, if a raw
    /// value needs to be provided.
    #[derive(Copy, Clone, Eq, PartialEq)]
    pub struct Type(c_int);

    impl Type {
        /// Type corresponding to `SOCK_STREAM`.
        ///
        /// Used for protocols such as TCP.
        pub const STREAM: Type = Type(sys::SOCK_STREAM);

        /// Type corresponding to `SOCK_DGRAM`.
        ///
        /// Used for protocols such as UDP.
        pub const DGRAM: Type = Type(sys::SOCK_DGRAM);

        /// Type corresponding to `SOCK_SEQPACKET`.
        #[cfg(feature = "all")]
        pub const SEQPACKET: Type = Type(sys::SOCK_SEQPACKET);

        /// Type corresponding to `SOCK_RAW`.
        #[cfg(all(feature = "all", not(target_os = "redox")))]
        pub const RAW: Type = Type(sys::SOCK_RAW);
    }

    impl From<c_int> for Type {
        fn from(t: c_int) -> Type {
            Type(t)
        }
    }

    impl From<Type> for c_int {
        fn from(t: Type) -> c_int {
            t.0
        }
    }

    /// Protocol specification used for creating sockets via `Socket::new`.
    ///
    /// This is a newtype wrapper around an integer which provides a nicer API in
    /// addition to an injection point for documentation.
    ///
    /// This type is freely interconvertible with C's `int` type, however, if a raw
    /// value needs to be provided.
    #[derive(Copy, Clone, Eq, PartialEq)]
    pub struct Protocol(c_int);

    impl Protocol {
        /// Protocol corresponding to `ICMPv4`.
        pub const ICMPV4: Protocol = Protocol(sys::IPPROTO_ICMP);

        /// Protocol corresponding to `ICMPv6`.
        pub const ICMPV6: Protocol = Protocol(sys::IPPROTO_ICMPV6);

        /// Protocol corresponding to `TCP`.
        pub const TCP: Protocol = Protocol(sys::IPPROTO_TCP);

        /// Protocol corresponding to `UDP`.
        pub const UDP: Protocol = Protocol(sys::IPPROTO_UDP);
    }

    impl From<c_int> for Protocol {
        fn from(p: c_int) -> Protocol {
            Protocol(p)
        }
    }

    impl From<Protocol> for c_int {
        fn from(p: Protocol) -> c_int {
            p.0
        }
    }

    /// Flags for incoming messages.
    ///
    /// Flags provide additional information about incoming messages.
    #[cfg(not(target_os = "redox"))]
    #[derive(Copy, Clone, Eq, PartialEq)]
    pub struct RecvFlags(c_int);

    #[cfg(not(target_os = "redox"))]
    impl RecvFlags {
        /// Check if the message contains a truncated datagram.
        ///
        /// This flag is only used for datagram-based sockets,
        /// not for stream sockets.
        ///
        /// On Unix this corresponds to the `MSG_TRUNC` flag.
        /// On Windows this corresponds to the `WSAEMSGSIZE` error code.
        pub const fn is_truncated(self) -> bool {
            self.0 & sys::MSG_TRUNC != 0
        }
    }

    /// A version of [`IoSliceMut`] that allows the buffer to be uninitialised.
    ///
    /// [`IoSliceMut`]: std::io::IoSliceMut
    #[repr(transparent)]
    pub struct MaybeUninitSlice<'a>(sys::MaybeUninitSlice<'a>);

    unsafe impl<'a> Send for MaybeUninitSlice<'a> {}

    unsafe impl<'a> Sync for MaybeUninitSlice<'a> {}

    impl<'a> fmt::Debug for MaybeUninitSlice<'a> {
        fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
            fmt::Debug::fmt(self.0.as_slice(), fmt)
        }
    }

    impl<'a> MaybeUninitSlice<'a> {
        /// Creates a new `MaybeUninitSlice` wrapping a byte slice.
        ///
        /// # Panics
        ///
        /// Panics on Windows if the slice is larger than 4GB.
        pub fn new(buf: &'a mut [MaybeUninit<u8>]) -> MaybeUninitSlice<'a> {
            MaybeUninitSlice(sys::MaybeUninitSlice::new(buf))
        }
    }

    impl<'a> Deref for MaybeUninitSlice<'a> {
        type Target = [MaybeUninit<u8>];

        fn deref(&self) -> &[MaybeUninit<u8>] {
            self.0.as_slice()
        }
    }

    impl<'a> DerefMut for MaybeUninitSlice<'a> {
        fn deref_mut(&mut self) -> &mut [MaybeUninit<u8>] {
            self.0.as_mut_slice()
        }
    }

    /// Configures a socket's TCP keepalive parameters.
    ///
    /// See [`Socket::set_tcp_keepalive`].
    #[derive(Debug, Clone)]
    pub struct TcpKeepalive {
        time: Option<Duration>,
        interval: Option<Duration>,
        retries: Option<u32>,
    }

    impl TcpKeepalive {
        /// Returns a new, empty set of TCP keepalive parameters.
        pub const fn new() -> TcpKeepalive {
            TcpKeepalive {
                time: None,
                interval: None,
                retries: None,
            }
        }

        /// Set the amount of time after which TCP keepalive probes will be sent on
        /// idle connections.
        ///
        /// This will set the value of `SO_KEEPALIVE` on OpenBSD and Haiku,
        /// `TCP_KEEPALIVE` on macOS and iOS, and `TCP_KEEPIDLE` on all other Unix
        /// operating systems. On Windows, this sets the value of the
        /// `tcp_keepalive` struct's `keepalivetime` field.
        ///
        /// Some platforms specify this value in seconds, so sub-second
        /// specifications may be omitted.
        pub const fn with_time(self, time: Duration) -> Self {
            Self {
                time: Some(time),
                ..self
            }
        }

        /// Set the value of the `TCP_KEEPINTVL` option. On Windows, this sets the
        /// value of the `tcp_keepalive` struct's `keepaliveinterval` field.
        ///
        /// Sets the time interval between TCP keepalive probes.
        ///
        /// Some platforms specify this value in seconds, so sub-second
        /// specifications may be omitted.
        #[cfg(all(
            feature = "all",
            any(
                target_os = "freebsd",
                target_os = "fuchsia",
                target_os = "linux",
                target_os = "netbsd",
                target_vendor = "apple",
                windows,
            )
        ))]
        pub const fn with_interval(self, interval: Duration) -> Self {
            Self {
                interval: Some(interval),
                ..self
            }
        }

        /// Set the value of the `TCP_KEEPCNT` option.
        ///
        /// Set the maximum number of TCP keepalive probes that will be sent before
        /// dropping a connection, if TCP keepalive is enabled on this socket.
        #[cfg(all(
            feature = "all",
            any(
                target_os = "freebsd",
                target_os = "fuchsia",
                target_os = "linux",
                target_os = "netbsd",
                target_vendor = "apple",
            )
        ))]
        pub const fn with_retries(self, retries: u32) -> Self {
            Self {
                retries: Some(retries),
                ..self
            }
        }
    }