Skip to main content

HostCallbackQueue

Struct HostCallbackQueue 

Source
pub struct HostCallbackQueue { /* private fields */ }
Expand description

Cloneable handle host callbacks use to enqueue packets into a stream.

Wraps a push StreamValue and enforces that every enqueued packet matches the device media. The handle is cheap to clone and callbacks enqueue through non-blocking calls.

Implementations§

Source§

impl HostCallbackQueue

Source

pub fn new(stream: Arc<StreamValue>) -> Self

Wraps a push stream, capturing its media for callback validation.

Source

pub fn stream(&self) -> Arc<StreamValue>

Returns a shared handle to the underlying stream value.

Source

pub fn callback_packet(&self, packet: StreamPacket) -> Result<PushResult>

Enqueues a packet from a host callback after checking its media.

Source

pub fn callback_item(&self, item: StreamItem) -> Result<PushResult>

Enqueues a prebuilt stream item from a host callback after checking its media.

Source

pub fn drain(&self, limit: usize) -> Result<Vec<StreamItem>>

Removes up to limit buffered items from the stream.

Source

pub fn close(&self) -> Result<()>

Closes the push side of the stream.

Source

pub fn cancel(&self) -> Result<()>

Cancels the stream and drops buffered packets.

Source

pub fn stats(&self) -> Result<StreamStats>

Returns the current stream statistics.

Source

pub fn inspector( &self, route: Symbol, profile: &TransportProfile, recent_diagnostics: Vec<Symbol>, ) -> Result<StreamInspectorSnapshot>

Builds an inspector snapshot for the stream on the given route and transport profile.

Trait Implementations§

Source§

impl Clone for HostCallbackQueue

Source§

fn clone(&self) -> HostCallbackQueue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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