Struct reactive_mutiny::uni::Uni

source ·
pub struct Uni<'a, ItemType: Send + Sync + Debug, UniChannelType: FullDuplexUniChannel<'a, ItemType, DerivedItemType>, const INSTRUMENTS: usize, DerivedItemType: Debug = ItemType> {
    pub uni_channel: Arc<UniChannelType>,
    pub stream_executor: Arc<StreamExecutor<INSTRUMENTS>>,
    pub finished_executors_count: AtomicU32,
    /* private fields */
}
Expand description

Contains the producer-side Uni handle used to interact with the uni event – for closing the stream, requiring stats, …

Fields§

§uni_channel: Arc<UniChannelType>§stream_executor: Arc<StreamExecutor<INSTRUMENTS>>§finished_executors_count: AtomicU32

Implementations§

source§

impl<'a, ItemType: Send + Sync + Debug + 'a, UniChannelType: FullDuplexUniChannel<'a, ItemType, DerivedItemType>, const INSTRUMENTS: usize, DerivedItemType: Debug> Uni<'a, ItemType, UniChannelType, INSTRUMENTS, DerivedItemType>

source

pub fn new<IntoString: Into<String>>( uni_name: IntoString, stream_executor: Arc<StreamExecutor<INSTRUMENTS>> ) -> Self

creates & returns a pair (Uni, UniStream)

source

pub fn try_send<F: FnOnce(&mut ItemType)>(&self, setter: F) -> bool

source

pub fn send<F: FnOnce(&mut ItemType)>(&self, setter: F)

source

pub fn try_send_movable(&self, item: ItemType) -> bool

source

pub fn consumer_stream( &self ) -> MutinyStream<'a, ItemType, UniChannelType, DerivedItemType>

source

pub async fn flush(&self, duration: Duration) -> u32

source

pub async fn close(&self, timeout: Duration) -> bool

closes this Uni, in isolation – flushing pending events, closing the producers, waiting for all events to be fully processed and calling the “on close” callback.
If this Uni share resources with another one (which will get dumped by the “on close” callback), most probably you want to close them atomically – see unis_close_async!()

Auto Trait Implementations§

§

impl<'a, ItemType, UniChannelType, const INSTRUMENTS: usize, DerivedItemType> RefUnwindSafe for Uni<'a, ItemType, UniChannelType, INSTRUMENTS, DerivedItemType>where DerivedItemType: RefUnwindSafe, ItemType: RefUnwindSafe, UniChannelType: RefUnwindSafe,

§

impl<'a, ItemType, UniChannelType, const INSTRUMENTS: usize, DerivedItemType> Send for Uni<'a, ItemType, UniChannelType, INSTRUMENTS, DerivedItemType>where DerivedItemType: Sync, UniChannelType: Send + Sync,

§

impl<'a, ItemType, UniChannelType, const INSTRUMENTS: usize, DerivedItemType> Sync for Uni<'a, ItemType, UniChannelType, INSTRUMENTS, DerivedItemType>where DerivedItemType: Sync, UniChannelType: Send + Sync,

§

impl<'a, ItemType, UniChannelType, const INSTRUMENTS: usize, DerivedItemType> Unpin for Uni<'a, ItemType, UniChannelType, INSTRUMENTS, DerivedItemType>

§

impl<'a, ItemType, UniChannelType, const INSTRUMENTS: usize, DerivedItemType> UnwindSafe for Uni<'a, ItemType, UniChannelType, INSTRUMENTS, DerivedItemType>where DerivedItemType: RefUnwindSafe, ItemType: RefUnwindSafe, UniChannelType: RefUnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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> Erased for T