Struct Reservation 

pub struct Reservation { /* private fields */ }

A reservation for a rate-limited event.

Created by Limiter::reserve(), this represents a reserved slot that must be explicitly committed or will automatically cancel on drop.

Examples

use tiny_counter::{EventStore, TimeUnit};

let store = EventStore::new();

// Reserve a slot
let reservation = store.limit()
    .at_most("api_call", 10, TimeUnit::Hours)
    .reserve("api_call")
    .unwrap();

// Do some work...
// If successful, commit
reservation.commit();

// If reservation is dropped without commit, it auto-cancels

Implementations

impl Reservation

pub fn commit(self)

Commit the reservation, recording the event.

This decrements the pending counter and records the event atomically.

pub fn cancel(self)

Cancel the reservation without recording the event.

This is equivalent to dropping the reservation without committing.

Trait Implementations

impl Drop for Reservation

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.