oxios-gateway 0.2.0

Channel-agnostic message gateway for Oxios
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

//! Channel trait definition.
//!
//! A channel is a plugin that connects the gateway to a specific
//! interface (Web, CLI, Telegram, etc.).

use anyhow::Result;
use async_trait::async_trait;

use crate::message::{IncomingMessage, OutgoingMessage};

/// A communication channel that plugs into the gateway.
#[async_trait]
pub trait Channel: Send + Sync {
    /// Returns the name of this channel (e.g., "web", "telegram").
    fn name(&self) -> &str;

    /// Receive the next incoming message, or None if the channel is closed.
    async fn receive(&self) -> Result<Option<IncomingMessage>>;

    /// Send a message through this channel.
    async fn send(&self, msg: OutgoingMessage) -> Result<()>;
}