Struct std::os::windows::io::socket::BorrowedSocket

#[repr(transparent)]
pub struct BorrowedSocket<'socket> {
    socket: RawSocket,
    _phantom: PhantomData<&'socket OwnedSocket>,
}

Available on Windows only.

A borrowed socket.

This has a lifetime parameter to tie it to the lifetime of something that owns the socket.

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 an argument, it is not captured or consumed, and it never has the value INVALID_SOCKET.

This type’s .to_owned() implementation returns another BorrowedSocket rather than an OwnedSocket. It just makes a trivial copy of the raw socket, which is then borrowed under the same lifetime.

Fields

socket: RawSocket

_phantom: PhantomData<&'socket OwnedSocket>

Implementations

impl BorrowedSocket<'_>

pub const unsafe fn borrow_raw(socket: RawSocket) -> Self

Return a BorrowedSocket holding the given raw socket.

Safety

The resource pointed to by raw must remain open for the duration of the returned BorrowedSocket, and it must not have the value INVALID_SOCKET.

impl BorrowedSocket<'_>

pub fn try_clone_to_owned(&self) -> Result<OwnedSocket>

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

Trait Implementations

impl AsRawSocket for BorrowedSocket<'_>

fn as_raw_socket(&self) -> RawSocket

Extracts the raw socket.

impl AsSocket for BorrowedSocket<'_>

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

Borrows the socket.

impl<'socket> Clone for BorrowedSocket<'socket>

fn clone(&self) -> BorrowedSocket<'socket>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorrowedSocket<'_>

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

Formats the value using the given formatter.

impl<'socket> Copy for BorrowedSocket<'socket>