CodecKit

Struct CodecKit 

Source
pub struct CodecKit<C> {
    pub codec: C,
}
Expand description

Generic typed-codec “kit” that builds typed producers/consumers for any codec.

The kit is intentionally tiny: it mostly provides constructors and a couple of ergonomic helpers. The underlying typed wrappers (indexbus-typed) are the source of truth.

Fields§

§codec: C

The codec instance used by the typed wrappers created by this kit.

Implementations§

Source§

impl<C> CodecKit<C>

Source

pub const fn new(codec: C) -> Self

Create a new codec kit from a codec instance.

Source§

impl<C: Copy> CodecKit<C>

Source

pub fn spsc_sender(self, inner: SpscSender) -> TypedSpscSender<C>

Wrap an SPSC sender with typed messaging.

Source

pub fn spsc_receiver(self, inner: SpscReceiver) -> TypedSpscReceiver<C>

Wrap an SPSC receiver with typed messaging.

Source

pub fn mpsc_producer(self, inner: MpscProducer) -> TypedMpscProducer<C>

Wrap an MPSC producer with typed messaging.

Source

pub fn mpsc_consumer(self, inner: MpscConsumer) -> TypedMpscConsumer<C>

Wrap an MPSC consumer with typed messaging.

Source

pub fn fanout_producer<const N: usize>( self, inner: FanoutProducer<N>, ) -> TypedFanoutProducer<N, C>

Wrap a fanout producer with typed messaging.

Source

pub fn fanout_consumer<const N: usize>( self, inner: FanoutConsumer<N>, ) -> TypedFanoutConsumer<N, C>

Wrap a fanout consumer with typed messaging.

Source

pub fn fanout_mpsc_producer<const N: usize>( self, inner: FanoutMpscProducer<N>, ) -> TypedFanoutMpscProducer<N, C>

Wrap a fanout MPSC producer with typed messaging.

Trait Implementations§

Source§

impl<C: Clone> Clone for CodecKit<C>

Source§

fn clone(&self) -> CodecKit<C>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C: Debug> Debug for CodecKit<C>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<C: Copy> Copy for CodecKit<C>

Auto Trait Implementations§

§

impl<C> Freeze for CodecKit<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for CodecKit<C>
where C: RefUnwindSafe,

§

impl<C> Send for CodecKit<C>
where C: Send,

§

impl<C> Sync for CodecKit<C>
where C: Sync,

§

impl<C> Unpin for CodecKit<C>
where C: Unpin,

§

impl<C> UnwindSafe for CodecKit<C>
where C: 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> 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.