    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

    #[cfg(not(io_safety_is_in_std))]
    #[cfg(any(unix, target_os = "wasi"))]
    use crate::BorrowedFd;
    #[cfg(any(unix, target_os = "wasi"))]
    use crate::OwnedFd;
    #[cfg(not(io_safety_is_in_std))]
    #[cfg(windows)]
    use crate::{BorrowedHandle, BorrowedSocket};
    #[cfg(windows)]
    use crate::{OwnedHandle, OwnedSocket};

    /// A trait to borrow the file descriptor from an underlying object.
    ///
    /// This is only available on unix platforms and must be imported in order to
    /// call the method. Windows platforms have a corresponding `AsHandle` and
    /// `AsSocket` set of traits.
    #[cfg(not(io_safety_is_in_std))]
    #[cfg(any(unix, target_os = "wasi"))]
    pub trait AsFd {
        /// Borrows the file descriptor.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{AsFd, BorrowedFd};
        ///
        /// let mut f = File::open("foo.txt")?;
        /// let borrowed_fd: BorrowedFd<'_> = f.as_fd();
        /// # Ok::<(), io::Error>(())
        /// ```
        fn as_fd(&self) -> BorrowedFd<'_>;
    }

    /// A trait to borrow the handle from an underlying object.
    #[cfg(not(io_safety_is_in_std))]
    #[cfg(windows)]
    pub trait AsHandle {
        /// Borrows the handle.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{AsHandle, BorrowedHandle};
        ///
        /// let mut f = File::open("foo.txt")?;
        /// let borrowed_handle: BorrowedHandle<'_> = f.as_handle();
        /// # Ok::<(), io::Error>(())
        /// ```
        fn as_handle(&self) -> BorrowedHandle<'_>;
    }

    /// A trait to borrow the socket from an underlying object.
    #[cfg(not(io_safety_is_in_std))]
    #[cfg(windows)]
    pub trait AsSocket {
        /// Borrows the socket.
        fn as_socket(&self) -> BorrowedSocket<'_>;
    }

    /// A trait to express the ability to consume an object and acquire ownership
    /// of its file descriptor.
    #[cfg(any(unix, target_os = "wasi"))]
    #[deprecated(
        since = "1.0.0",
        note = "`IntoFd` is replaced by `From<...> for OwnedFd` or `Into<OwnedFd>`"
    )]
    pub trait IntoFd {
        /// Consumes this object, returning the underlying file descriptor.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{IntoFd, OwnedFd};
        ///
        /// let f = File::open("foo.txt")?;
        /// let owned_fd: OwnedFd = f.into_fd();
        /// # Ok::<(), io::Error>(())
        /// ```
        fn into_fd(self) -> OwnedFd;
    }

    /// A trait to express the ability to consume an object and acquire ownership
    /// of its handle.
    #[cfg(windows)]
    #[deprecated(
        since = "1.0.0",
        note = "`IntoHandle` is replaced by `From<...> for OwnedHandle` or `Into<OwnedHandle>`"
    )]
    pub trait IntoHandle {
        /// Consumes this object, returning the underlying handle.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{IntoHandle, OwnedHandle};
        ///
        /// let f = File::open("foo.txt")?;
        /// let owned_handle: OwnedHandle = f.into_handle();
        /// # Ok::<(), io::Error>(())
        /// ```
        fn into_handle(self) -> OwnedHandle;
    }

    /// A trait to express the ability to consume an object and acquire ownership
    /// of its socket.
    #[cfg(windows)]
    #[deprecated(
        since = "1.0.0",
        note = "`IntoSocket` is replaced by `From<...> for OwnedSocket` or `Into<OwnedSocket>`"
    )]
    pub trait IntoSocket {
        /// Consumes this object, returning the underlying socket.
        fn into_socket(self) -> OwnedSocket;
    }

    /// A trait to express the ability to construct an object from a file
    /// descriptor.
    #[cfg(any(unix, target_os = "wasi"))]
    pub trait FromFd {
        /// Constructs a new instance of `Self` from the given file descriptor.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{FromFd, IntoFd, OwnedFd};
        ///
        /// let f = File::open("foo.txt")?;
        /// let owned_fd: OwnedFd = f.into_fd();
        /// let f = File::from_fd(owned_fd);
        /// # Ok::<(), io::Error>(())
        /// ```
        #[deprecated(
            since = "1.0.0",
            note = "`FromFd::from_fd` is replaced by `From<OwnedFd>::from`"
        )]
        fn from_fd(owned: OwnedFd) -> Self;

        /// Constructs a new instance of `Self` from the given file descriptor
        /// converted from `into_owned`.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{FromFd, IntoFd};
        ///
        /// let f = File::open("foo.txt")?;
        /// let f = File::from_into_fd(f);
        /// # Ok::<(), io::Error>(())
        /// ```
        #[inline]
        fn from_into_fd<Owned: Into<OwnedFd>>(into_owned: Owned) -> Self
        where
            Self: Sized + From<OwnedFd>,
        {
            Self::from(into_owned.into())
        }
    }

    /// A trait to express the ability to construct an object from a handle.
    #[cfg(windows)]
    pub trait FromHandle {
        /// Constructs a new instance of `Self` from the given handle.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{FromHandle, IntoHandle, OwnedHandle};
        ///
        /// let f = File::open("foo.txt")?;
        /// let owned_handle: OwnedHandle = f.into_handle();
        /// let f = File::from_handle(owned_handle);
        /// # Ok::<(), io::Error>(())
        /// ```
        #[deprecated(
            since = "1.0.0",
            note = "`FromHandle::from_handle` is replaced by `From<OwnedHandle>::from`"
        )]
        fn from_handle(owned: OwnedHandle) -> Self;

        /// Constructs a new instance of `Self` from the given handle converted
        /// from `into_owned`.
        ///
        /// # Example
        ///
        /// ```rust,no_run
        /// use std::fs::File;
        /// # use std::io;
        /// use io_lifetimes::{FromHandle, IntoHandle};
        ///
        /// let f = File::open("foo.txt")?;
        /// let f = File::from_into_handle(f);
        /// # Ok::<(), io::Error>(())
        /// ```
        #[inline]
        fn from_into_handle<Owned: Into<OwnedHandle>>(into_owned: Owned) -> Self
        where
            Self: Sized + From<OwnedHandle>,
        {
            Self::from(into_owned.into())
        }
    }

    /// A trait to express the ability to construct an object from a socket.
    #[cfg(windows)]
    pub trait FromSocket {
        /// Constructs a new instance of `Self` from the given socket.
        #[deprecated(
            since = "1.0.0",
            note = "`FromSocket::from_socket` is replaced by `From<OwnedSocket>::from`"
        )]
        fn from_socket(owned: OwnedSocket) -> Self;

        /// Constructs a new instance of `Self` from the given socket converted
        /// from `into_owned`.
        #[inline]
        fn from_into_socket<Owned: Into<OwnedSocket>>(into_owned: Owned) -> Self
        where
            Self: Sized + From<OwnedSocket>,
        {
            Self::from(into_owned.into())
        }
    }

    #[cfg(not(io_safety_is_in_std))]
    #[cfg(any(unix, target_os = "wasi"))]
    impl<T: AsFd> AsFd for &T {
        #[inline]
        fn as_fd(&self) -> BorrowedFd<'_> {
            T::as_fd(self)
        }
    }

    #[cfg(not(io_safety_is_in_std))]
    #[cfg(any(unix, target_os = "wasi"))]
    impl<T: AsFd> AsFd for &mut T {
        #[inline]
        fn as_fd(&self) -> BorrowedFd<'_> {
            T::as_fd(self)
        }
    }

    #[cfg(not(io_safety_is_in_std))]
    #[cfg(windows)]
    impl<T: AsHandle> AsHandle for &T {
        #[inline]
        fn as_handle(&self) -> BorrowedHandle<'_> {
            T::as_handle(self)
        }
    }

    #[cfg(not(io_safety_is_in_std))]
    #[cfg(windows)]
    impl<T: AsHandle> AsHandle for &mut T {
        #[inline]
        fn as_handle(&self) -> BorrowedHandle<'_> {
            T::as_handle(self)
        }
    }

    #[cfg(not(io_safety_is_in_std))]
    #[cfg(windows)]
    impl<T: AsSocket> AsSocket for &T {
        #[inline]
        fn as_socket(&self) -> BorrowedSocket<'_> {
            T::as_socket(self)
        }
    }

    #[cfg(not(io_safety_is_in_std))]
    #[cfg(windows)]
    impl<T: AsSocket> AsSocket for &mut T {
        #[inline]
        fn as_socket(&self) -> BorrowedSocket<'_> {
            T::as_socket(self)
        }
    }