src/output_protocol.rs


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

use std::sync::Arc;

#[cfg(unix)]
pub mod ipc;
pub mod stderr;
pub mod stdout;
pub mod tcp;
pub mod udp;
pub mod udp_broadcast;

#[cfg(unix)]
pub use ipc::*;
pub use stderr::*;
pub use stdout::*;
pub use tcp::*;
pub use udp::*;
pub use udp_broadcast::*;

/// Defines the protocol for an output channel that can be initialized and used to send messages.
///
/// Implementors of this trait provide the underlying mechanism for message delivery,
/// such as writing to stdout, a file, or a network socket.
///
/// # Type Parameters
///
/// The trait methods return `impl Future<Output = ()> + Send + Sync`, allowing
/// asynchronous implementations that can be shared across threads.
pub trait OutputProtocol {
    /// Initializes the output channel.
    ///
    /// Prepares the output resource (e.g., opening a file, establishing a connection).
    ///
    /// # Returns
    ///
    /// A future that resolves when initialization is complete.
    fn init(&self) -> impl Future<Output = ()> + Send + Sync;

    /// Sends a message string through the output channel.
    ///
    /// This method takes `self: Arc<Self>`, allowing the output channel to be shared
    /// across multiple concurrent senders (e.g., in multi-threaded or async contexts).
    ///
    /// # Arguments
    ///
    /// * `str` - The string message to send.
    ///
    /// # Returns
    ///
    /// A future that resolves when the message has been sent.
    fn send(self: Arc<Self>, str: &str) -> impl Future<Output = ()> + Send + Sync;
}