job_abstrs 0.1.0

Abstractions for event-driven jobs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

use async_trait::async_trait;

/// The sending side of a multiple-producer channel.
#[async_trait]
pub trait MpSender: Clone {
    /// The type of messages sent along the channel.
    type Message;

    /// The type of error that can occur when sending a message along the
    /// channel.
    type Error;

    /// Attempts to send a message on the channel.
    async fn send(&self, msg: Self::Message) -> Result<(), Self::Error>;
}

/// The receiving side of a multiple-consumer channel.
#[async_trait]
pub trait McReceiver: Clone {
    /// The type of messages sent along the channel.
    type Message;

    /// The type of error that can occur when receiving a message from the
    /// channel.
    type Error;

    /// Attempts to wait for a message on the channel.
    async fn receive(&self) -> Result<Self::Message, Self::Error>;
}