Struct unsafe_io::os::windows::RawHandleOrSocket

#[repr(transparent)]pub struct RawHandleOrSocket(_);

A Windows analog for the Posix-ish AsRawFd type. Unlike Posix-ish platforms which have a single type for files and sockets, Windows has distinct types, RawHandle and RawSocket. And unlike Posix-ish platforms where text streams are generally UTF-8, the Windows Console is UTF-16. This type behaves like an enum which can hold either a handle or a socket, and to which UTF-8 text can be written.

It’s reasonable to worry that this might be trying too hard to make Windows work like Posix-ish platforms, however in this case, the number of types is small, so the enum is simple and the overhead is relatively low, and the benefit is that we can abstract over major Read and Write resources.

Implementations

impl RawHandleOrSocket

#[must_use]pub const fn unowned_from_raw_handle(raw_handle: RawHandle) -> Self

Like FromRawHandle::from_raw_handle, but isn’t unsafe because it doesn’t imply a dereference.

#[must_use]pub const fn unowned_from_raw_socket(raw_socket: RawSocket) -> Self

Like FromRawSocket::from_raw_socket, but isn’t unsafe because it doesn’t imply a dereference.

#[must_use]pub fn as_unowned_raw_handle(&self) -> Option<RawHandle>

Like AsRawHandle::as_raw_handle, but returns an Option so that it can return None if self doesn’t contain a RawHandle.

#[must_use]pub const fn as_unowned_raw_socket(&self) -> Option<RawSocket>

Like AsRawSocket::as_raw_socket, but returns an Option so that it can return None if self doesn’t contain a RawSocket.

#[must_use]pub const fn stdin() -> Self

Return a RawHandleOrSocket representing stdin.

This differs from unowned_from_raw_handle on the stdin handle in two ways:

• It tracks the stdin handle, which may change dynamically via SetStdHandle.
• When stdin is attached to a console, reads from this handle via UnsafeReadable are decoded into UTF-8.

#[must_use]pub const fn stdout() -> Self

Return a RawHandleOrSocket representing stdout.

This differs from unowned_from_raw_handle on the stdout handle in two ways:

• It tracks the stdout handle, which may change dynamically via SetStdHandle.
• When stdout is attached to a console, writes to this handle via UnsafeWriteable are encoded from UTF-8.

#[must_use]pub const fn stderr() -> Self

Return a RawHandleOrSocket representing stderr.

This differs from unowned_from_raw_handle on the stderr handle in two ways:

• It tracks the stderr handle, which may change dynamically via SetStdHandle.
• When stderr is attached to a console, writes to this handle via UnsafeWriteable are encoded from UTF-8.

Trait Implementations

impl AsRawHandleOrSocket for RawHandleOrSocket

fn as_raw_handle_or_socket(&self) -> Self

Like AsRawHandle::as_raw_handle and AsRawSocket::as_raw_socket but can return either type.

impl Clone for RawHandleOrSocket

fn clone(&self) -> RawHandleOrSocket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RawHandleOrSocket

impl Debug for RawHandleOrSocket

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

Formats the value using the given formatter.

impl Eq for RawHandleOrSocket

impl Hash for RawHandleOrSocket

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for RawHandleOrSocket

fn cmp(&self, other: &RawHandleOrSocket) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RawHandleOrSocket> for RawHandleOrSocket

fn eq(&self, other: &RawHandleOrSocket) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RawHandleOrSocket) -> bool

This method tests for !=.

impl PartialOrd<RawHandleOrSocket> for RawHandleOrSocket

fn partial_cmp(&self, other: &RawHandleOrSocket) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for RawHandleOrSocket

The Windows HANDLE and SOCKET types may be sent between threads.

impl StructuralEq for RawHandleOrSocket

impl StructuralPartialEq for RawHandleOrSocket

impl Sync for RawHandleOrSocket

The Windows HANDLE and SOCKET types may be shared between threads.