Struct BauBot

pub struct BauBot<Db: BauData + Send + Sync + 'static, DbRef: Deref<Target = Db> + Clone + Send + Sync + 'static> { /* private fields */ }

BauBot

Call BauBot::new with a BauData database to start the server(s). A new instance of BauBot is created that implements Deref to a broadcaster::types::ClientSocket (for sending a broadcaster::types::BauMessage) to BauBot.

Under the hood, calling BauBot::new orchestrates and wraps a number of tasks. See BauBot::new for more information.

Implementations

impl<Db: BauData + Send + Sync + 'static, DbRef: Deref<Target = Db> + Clone + Send + Sync + 'static> BauBot<Db, DbRef>

pub fn new<S: Into<String>>(db: DbRef, token: S) -> Self

Creates a new BauBot. This runs a number of concurrent tasks

• (test mode) Initialise environment variables and logger
• Initialises a request server to listen for requests sent through a broadcaster::types::ClientSocket
• Initialises a [Bot] to interact with telegram

Methods from Deref<Target = ClientSocket>

pub fn send(&self, message: T) -> Result<(), SendError<T>>

Attempts to send a message on this UnboundedSender without blocking.

This method is not marked async because sending a message to an unbounded channel never requires any form of waiting. Because of this, the send method can be used in both synchronous and asynchronous code without problems.

If the receive half of the channel is closed, either due to close being called or the UnboundedReceiver having been dropped, this function returns an error. The error includes the value passed to send.

pub async fn closed(&self)

Completes when the receiver has dropped.

This allows the producers to get notified when interest in the produced values is canceled and immediately stop doing work.

Cancel safety

This method is cancel safe. Once the channel is closed, it stays closed forever and all future calls to closed will return immediately.

Examples

use tokio::sync::mpsc;

#[tokio::main]
async fn main() {
    let (tx1, rx) = mpsc::unbounded_channel::<()>();
    let tx2 = tx1.clone();
    let tx3 = tx1.clone();
    let tx4 = tx1.clone();
    let tx5 = tx1.clone();
    tokio::spawn(async move {
        drop(rx);
    });

    futures::join!(
        tx1.closed(),
        tx2.closed(),
        tx3.closed(),
        tx4.closed(),
        tx5.closed()
    );
}

pub fn is_closed(&self) -> bool

Checks if the channel has been closed. This happens when the UnboundedReceiver is dropped, or when the UnboundedReceiver::close method is called.

let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>();
assert!(!tx.is_closed());

let tx2 = tx.clone();
assert!(!tx2.is_closed());

drop(rx);
assert!(tx.is_closed());
assert!(tx2.is_closed());

pub fn same_channel(&self, other: &UnboundedSender<T>) -> bool

Returns true if senders belong to the same channel.

Examples

let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<()>();
let  tx2 = tx.clone();
assert!(tx.same_channel(&tx2));

let (tx3, rx3) = tokio::sync::mpsc::unbounded_channel::<()>();
assert!(!tx3.same_channel(&tx2));

pub fn downgrade(&self) -> WeakUnboundedSender<T>

Converts the UnboundedSender to a [WeakUnboundedSender] that does not count towards RAII semantics, i.e. if all UnboundedSender instances of the channel were dropped and only WeakUnboundedSender instances remain, the channel is closed.

pub fn strong_count(&self) -> usize

Returns the number of [UnboundedSender] handles.

pub fn weak_count(&self) -> usize

Returns the number of [WeakUnboundedSender] handles.

Trait Implementations

impl<Db: BauData + Send + Sync + 'static, DbRef: Deref<Target = Db> + Clone + Send + Sync + 'static> AsRef<UnboundedSender<BauMessage>> for BauBot<Db, DbRef>

fn as_ref(&self) -> &ClientSocket

Converts this type into a shared reference of the (usually inferred) input type.

impl<Db: BauData + Send + Sync + 'static, DbRef: Deref<Target = Db> + Clone + Send + Sync + 'static> Deref for BauBot<Db, DbRef>

type Target = UnboundedSender<BauMessage>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Db: BauData + Send + Sync, DbRef: Deref<Target = Db> + Clone + Send + Sync + 'static> Drop for BauBot<Db, DbRef>

Ensures that all threads are stopped on drop

fn drop(&mut self)

Executes the destructor for this type.