calandria 0.0.1-rc.2

Bounded reactor framework for explicit single-owner systems
Documentation
//! Construction of one bounded mailbox ownership pair.

use std::marker::PhantomData;

use crate::{
    Retained, RetainedBytes, WakeHandle,
    sync::{Arc, Mutex},
};

use super::{
    MailboxLimits, MailboxReceiver, MailboxSender,
    shared::{Counters, Shared, State},
};

/// Creates a mailbox using [`Retained`] for admission accounting.
pub fn mailbox<T: Retained>(
    limits: MailboxLimits,
    wake: WakeHandle,
) -> (MailboxSender<T>, MailboxReceiver<T>) {
    mailbox_with(limits, Retained::retained_bytes, wake)
}

/// Creates a mailbox using a caller-selected deterministic measurement function.
pub fn mailbox_with<T>(
    limits: MailboxLimits,
    measure: fn(&T) -> RetainedBytes,
    wake: WakeHandle,
) -> (MailboxSender<T>, MailboxReceiver<T>) {
    let shared = Arc::new(Shared {
        limits,
        state: Mutex::new(State::new(limits)),
        counters: Counters::new(),
        measure,
        wake,
    });
    (
        MailboxSender {
            shared: Arc::clone(&shared),
        },
        MailboxReceiver {
            shared,
            _single_consumer: PhantomData,
        },
    )
}