# Struct 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 duplicate 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit` #126799)
Performs copy-assignment from `self` to `dest`. 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.