Skip to main content

CreditSink

Struct CreditSink 

Source
pub struct CreditSink<S: ChannelSink> { /* private fields */ }
Expand description

A ChannelSink wrapper that enforces credit-based flow control.

Each send_payload acquires one permit from the semaphore, blocking if credit is zero. The semaphore is shared with the driver so that incoming GrantCredit messages can add permits via CreditSink::credit.

Implementations§

Source§

impl<S: ChannelSink> CreditSink<S>

Source

pub fn new(inner: S, initial_credit: u32) -> Self

Wrap inner with initial_credit permits (the const generic N).

Source

pub fn credit(&self) -> &Arc<Semaphore>

Returns the credit semaphore. The driver holds a clone so GrantCredit messages can call add_permits.

Trait Implementations§

Source§

impl<S: ChannelSink> ChannelSink for CreditSink<S>

Available on non-WebAssembly only.
Source§

fn send_payload<'payload>( &self, payload: Payload<'payload>, ) -> Pin<Box<dyn Future<Output = Result<(), TxError>> + Send + 'payload>>

Source§

fn close_channel( &self, metadata: Metadata<'_>, ) -> Pin<Box<dyn Future<Output = Result<(), TxError>> + Send + 'static>>

Source§

fn close_channel_on_drop(&self)

Synchronous drop-time close signal. Read more

Auto Trait Implementations§

§

impl<S> Freeze for CreditSink<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for CreditSink<S>
where S: RefUnwindSafe,

§

impl<S> Send for CreditSink<S>

§

impl<S> Sync for CreditSink<S>

§

impl<S> Unpin for CreditSink<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for CreditSink<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for CreditSink<S>
where S: UnwindSafe,

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.
Source§

impl<T> ChannelLiveness for T
where T: Send + Sync + 'static,

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,