Struct std::os::windows::io::OwnedSocket

#[repr(transparent)]
pub struct OwnedSocket { /* private fields */ }

🔬 This is a nightly-only experimental API. (io_safety #87074)

This is supported on Windows only.

An owned socket.

This closes the socket on drop.

This uses repr(transparent) and has the representation of a host socket, so it can be used in FFI in places where a socket is passed as a consumed argument or returned as an owned value, and it never has the value INVALID_SOCKET.

Implementations

impl OwnedSocket

pub fn try_clone(&self) -> Result<Self>

🔬 This is a nightly-only experimental API. (io_safety #87074)

Creates a new OwnedSocket instance that shares the same underlying socket as the existing OwnedSocket instance.

Trait Implementations

impl AsRawSocket for OwnedSocket

fn as_raw_socket(&self) -> RawSocket

Extracts the underlying raw socket from this object.

impl AsSocket for OwnedSocket

fn as_socket(&self) -> BorrowedSocket<'_>

🔬 This is a nightly-only experimental API. (io_safety #87074)

Borrows the socket.

impl Debug for OwnedSocket

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

Formats the value using the given formatter.

impl Drop for OwnedSocket

fn drop(&mut self)

Executes the destructor for this type.

impl From<OwnedSocket> for TcpStream

fn from(owned: OwnedSocket) -> Self

Performs the conversion.

impl From<OwnedSocket> for TcpListener

fn from(owned: OwnedSocket) -> Self

Performs the conversion.

impl From<OwnedSocket> for UdpSocket

fn from(owned: OwnedSocket) -> Self

Performs the conversion.

impl From<TcpListener> for OwnedSocket

fn from(tcp_listener: TcpListener) -> OwnedSocket

Performs the conversion.

impl From<TcpStream> for OwnedSocket

fn from(tcp_stream: TcpStream) -> OwnedSocket

Performs the conversion.

impl From<UdpSocket> for OwnedSocket

fn from(udp_socket: UdpSocket) -> OwnedSocket

Performs the conversion.

impl FromRawSocket for OwnedSocket

unsafe fn from_raw_socket(socket: RawSocket) -> Self

Constructs a new instance of Self from the given raw socket.

Safety

The resource pointed to by socket must be open and suitable for assuming ownership. The resource must not require cleanup other than closesocket.

impl IntoRawSocket for OwnedSocket

fn into_raw_socket(self) -> RawSocket

Consumes this object, returning the raw underlying socket.