async-wsocket 0.14.0

A convenience library for using websockets both in native and WASM environments!
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// Copyright (c) 2019-2022 Naja Melan
// Copyright (c) 2023-2024 Yuki Kishimoto
// Distributed under the MIT software license

use super::{Filter, Observe};

pub trait Observable<Event>
where
    Event: Clone + 'static + Send,
{
    /// The error type that is returned if observing is not possible.
    ///
    /// [Pharos](crate::Pharos) implements
    /// [Sink](https://docs.rs/futures-preview/0.3.0-alpha.19/futures/sink/trait.Sink.html)
    /// which has a close method, so observing will no longer be possible after close is called.
    ///
    /// Other than that, you might want to have moments in your objects lifetime when you don't want to take
    /// any more observers. Returning a result from [observe](Observable::observe) enables that.
    ///
    /// You can of course map the error of pharos to your own error type.
    type Error: std::error::Error;

    /// Add an observer to the observable. Options allow chosing the channel type and
    /// to filter events with a predicate.
    fn observe(&mut self, options: ObserveConfig<Event>) -> Observe<'_, Event, Self::Error>;
}

#[derive(Debug)]
pub struct ObserveConfig<Event>
where
    Event: Clone + 'static + Send,
{
    pub(crate) filter: Option<Filter<Event>>,
}

/// Create a default configuration:
/// - no filter
/// - an unbounded channel
impl<Event> Default for ObserveConfig<Event>
where
    Event: Clone + 'static + Send,
{
    fn default() -> Self {
        Self { filter: None }
    }
}

/// Create a [ObserveConfig] from a [Filter], getting default values for other options.
impl<Event> From<Filter<Event>> for ObserveConfig<Event>
where
    Event: Clone + 'static + Send,
{
    fn from(filter: Filter<Event>) -> Self {
        Self {
            filter: Some(filter),
        }
    }
}