pubnub 0.7.0

PubNub SDK for Rust
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
30
31

use crate::{
    core::event_engine::EffectInvocation,
    lib::alloc::{boxed::Box, string::String, vec::Vec},
};

#[async_trait::async_trait]
pub(crate) trait Effect: Send + Sync {
    type Invocation: EffectInvocation;

    /// Effect name.
    fn name(&self) -> String;

    /// Unique effect identifier.
    fn id(&self) -> String;

    /// Run actual effect implementation.
    async fn run(&self) -> Vec<<Self::Invocation as EffectInvocation>::Event>;

    /// Cancel any ongoing effect's work.
    fn cancel(&self);

    /// Check whether effect has been cancelled.
    ///
    /// Event engine dispatch effects asynchronously and there is a chance that
    /// effect already has been cancelled.
    ///
    /// # Returns
    ///
    /// `true` if effect has been cancelled.   
    fn is_cancelled(&self) -> bool;
}