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

1.63.0 · source ·
pub struct BorrowedSocket<'socket> { /* private fields */ }
Available on Windows only.
Expand description

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.

Implementations§

source§

impl BorrowedSocket<'_>

1.63.0 (const: 1.63.0) · source

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

Returns 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.

source§

impl BorrowedSocket<'_>

1.63.0 · source

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§

1.63.0 · source§

impl AsRawSocket for BorrowedSocket<'_>

source§

fn as_raw_socket(&self) -> RawSocket

Extracts the raw socket. Read more
1.63.0 · source§

impl AsSocket for BorrowedSocket<'_>

source§

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

Borrows the socket.
1.63.0 · source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
1.63.0 · source§

impl Debug for BorrowedSocket<'_>

source§

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

Formats the value using the given formatter. Read more
1.63.0 · source§

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

Auto Trait Implementations§

§

impl<'socket> Freeze for BorrowedSocket<'socket>

§

impl<'socket> RefUnwindSafe for BorrowedSocket<'socket>

§

impl<'socket> Send for BorrowedSocket<'socket>

§

impl<'socket> Sync for BorrowedSocket<'socket>

§

impl<'socket> Unpin for BorrowedSocket<'socket>

§

impl<'socket> UnwindSafe for BorrowedSocket<'socket>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.