Skip to main content

HurrayTransport

Struct HurrayTransport 

Source
#[repr(C)]
pub struct HurrayTransport { pub ctx: *mut c_void, pub read: HurrayTransportReadFn, pub write: HurrayTransportWriteFn, pub release: HurrayTransportReleaseFn, pub read_at: HurrayTransportReadAtFn, pub size: HurrayTransportSizeFn, }
Expand description

A caller-supplied byte transport: a context pointer plus the callbacks that move bytes.

Not a path and not a file descriptor. A vtable composes with a socket, a pipe, a memory span, or the caller’s own object, and file descriptors are a portability wart of their own.

The struct is copied on construction, so the caller MAY free the HurrayTransport itself as soon as the handle is created; ctx must outlive the handle, and is released through release when the handle is destroyed.

Thread affinity: one handle, one thread at a time. Hurray runs no threads of its own, so this is a rule rather than a threading model.

Fields§

§ctx: *mut c_void

Opaque caller context, passed verbatim to every callback. MAY be null.

§read: HurrayTransportReadFn

Required by a reader; MAY be null for a write-only transport.

§write: HurrayTransportWriteFn

Required by a writer; MAY be null for a read-only transport.

§release: HurrayTransportReleaseFn

Invoked once when the owning handle is destroyed. MAY be null.

§read_at: HurrayTransportReadAtFn

Required by a file reader; MAY be null for a stream or write-only transport.

§size: HurrayTransportSizeFn

Required by a file reader; MAY be null for a stream or write-only transport.

Trait Implementations§

Source§

impl Default for HurrayTransport

Source§

fn default() -> Self

A vtable with no context and no callbacks — the {0} a C caller starts from, spelled for Rust callers who fill in only the fields their transport has.

Auto Trait Implementations§

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