subduction_websocket 0.1.0

WebSocket implementation for Subduction
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

//! A trait for types that can start listening for incoming messages as a background task.

use tokio::task::JoinHandle;

use crate::error::RunError;

/// A trait for types that can start listening for incoming messages as a background task.
pub trait Start {
    /// Start listening for incoming messages as a background task.
    fn start(&self) -> JoinHandle<Result<(), RunError>>;
}

/// A wrapper type indicating that the inner `T` has not yet been started.
///
/// This must be consumed to access the inner `T`, either by starting it
/// with [`Unstarted::start`] or by explicitly consuming it without starting it.
#[derive(Debug, Clone, Copy)]
pub struct Unstarted<T>(pub(crate) T);

impl<T: Start> Unstarted<T> {
    /// Start listening for incoming messages as a background task.
    pub fn start(self) -> T {
        self.0.start();
        self.0
    }

    /// Consume the `Unstarted`, returning the inner type *without* starting it.
    pub fn ignore(self) -> T {
        self.0
    }
}