Skip to main content

SendCooldown

Struct SendCooldown 

Source
pub struct SendCooldown { /* private fields */ }
Expand description

A cooldown ledger over the Database port. Construct it with the table the owning module declares (e.g. "<module>_send_cooldown"); the owning module ships create_table_sql as a migration.

Timestamps are RFC 3339 strings from the Clock port, the same shape the house stores in TEXT columns everywhere: lexicographic order on that format is chronological order, which is what the window compare relies on.

Implementations§

Source§

impl SendCooldown

Source

pub fn new(table: impl Into<String>) -> Self

Source

pub fn create_table_sql(&self) -> String

The portable DDL for the cooldown table (renders identically on SQLite/D1 and Postgres, ADR 0004).

Source

pub async fn try_acquire( &self, db: &dyn Database, subject: &str, now: &str, cutoff: &str, ) -> Result<bool, DbError>

Claims the send window for subject: true for the one caller whose claim lands, false for anyone inside the window.

now is the RFC 3339 timestamp to record, cutoff the instant (now - window) after which an expired claim may be renewed. The update-then-insert pair is race-free: the guarded UPDATE can be won by exactly one writer, and the conflict-insert covers the row not existing (yet).

§Errors

Returns DbError if either write fails.

Source

pub async fn release( &self, db: &dyn Database, subject: &str, ) -> Result<(), DbError>

Releases a claim so the window is not consumed by a send that never started (e.g. the mailer port answered NotConfigured).

§Errors

Returns DbError if the delete fails.

Source

pub async fn prune( &self, db: &dyn Database, before: &str, ) -> Result<u64, DbError>

Deletes claims older than before (rows whose window has closed anyway). Returns the number removed; a module calls this from its scheduled handler.

§Errors

Returns DbError if the delete fails.

Trait Implementations§

Source§

impl Clone for SendCooldown

Source§

fn clone(&self) -> SendCooldown

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SendCooldown

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more