Struct ClientBudget

pub struct ClientBudget {
    pub time_limit: Option<Duration>,
    pub max_bytes_read: Option<u64>,
    pub max_bytes_written: Option<u64>,
    pub clock: Option<Arc<dyn Clock>>,
}

Client-side limits applied to a single transaction attempt.

Each field is optional, None meaning “no limit”. A default ClientBudget limits nothing.

See the module documentation: these limits are computed by the binding from what it observes, not enforced by FoundationDB.

Example

let trx = db.create_trx()?;
trx.set_client_budget(ClientBudget {
    time_limit: Some(Duration::from_secs(2)),
    max_bytes_read: Some(10 * 1024 * 1024),
    ..ClientBudget::default()
});

Fields

time_limit: Option<Duration>

Maximum time an attempt may spend, measured from the start of the attempt with the clock of this budget.

max_bytes_read: Option<u64>

Maximum number of bytes read by an attempt, keys and values summed.

max_bytes_written: Option<u64>

Maximum number of bytes written by an attempt, keys, values and mutation parameters summed.

clock: Option<Arc<dyn Clock>>

Where time_limit reads time from, None meaning the WallClock.

Set it with with_clock to keep time budgets deterministic, see the module documentation.

Implementations

impl ClientBudget

pub fn with_clock(self, clock: impl Clock + 'static) -> Self

Measures the attempts with clock instead of the WallClock.

Trait Implementations

impl Clone for ClientBudget

fn clone(&self) -> ClientBudget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBudget

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

Formats the value using the given formatter.

impl Default for ClientBudget

fn default() -> ClientBudget

Returns the “default value” for a type.