Struct BorrowedCStream 

pub struct BorrowedCStream<'a> { /* private fields */ }

A borrowed RawCStream.

This has a lifetime parameter to tie it to the lifetime of something that owns the stream. For the duration of that lifetime, it is guaranteed that nobody will close the stream.

This uses #[repr(transparent)] and has the representation of a host stream, so it can be used in FFI in places where a file descriptor is passed as an argument, it is not captured or consumed, and it never has the value NULL.

This type’s Clone implementation returns another BorrowedCStream rather than an OwnedCStream. It just makes a trivial copy of the raw file descriptor, which is then borrowed under the same lifetime.

Implementations

impl<'a> BorrowedCStream<'a>

pub const unsafe fn borrow_raw(raw: RawCStream) -> Self

Return a BorrowedCStream holding the given stream.

Safety

The resource pointed to by raw must remain open for the duration of the returned BorrowedCStream.

Trait Implementations

impl AsCStream for BorrowedCStream<'_>

fn as_c_stream(&self) -> BorrowedCStream<'_>

Borrows the stream.

impl AsRawCStream for BorrowedCStream<'_>

fn as_raw_c_stream(&self) -> RawCStream

Extracts the raw stream.

impl<'a> Clone for BorrowedCStream<'a>

fn clone(&self) -> BorrowedCStream<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BorrowedCStream<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for BorrowedCStream<'a>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for BorrowedCStream<'a>

fn cmp(&self, other: &BorrowedCStream<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for BorrowedCStream<'a>

fn eq(&self, other: &BorrowedCStream<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for BorrowedCStream<'a>

fn partial_cmp(&self, other: &BorrowedCStream<'a>) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<'a> Copy for BorrowedCStream<'a>

impl<'a> Eq for BorrowedCStream<'a>

impl<'a> StructuralPartialEq for BorrowedCStream<'a>