LeaseConfig

Struct LeaseConfig 

Source
pub struct LeaseConfig {
    pub enabled: bool,
    pub interval_ms: u64,
    pub max_cleanup_duration_ms: u64,
}
Expand description

Lease configuration for TTL-based key expiration

When enabled = true:

  • Server initializes lease manager at startup
  • Background worker periodically cleans expired keys
  • Client TTL requests (ttl_secs > 0) are accepted

When enabled = false (default):

  • No lease components initialized (zero overhead)
  • Client TTL requests (ttl_secs > 0) are rejected with error
  • All keys are permanent (ttl_secs = 0 is always allowed)

§Performance

Background cleanup overhead: ~0.001% CPU

  • Wakes up every interval_ms (default 1000ms)
  • Scans expired keys (limited by max_cleanup_duration_ms)
  • Deletes expired entries from storage

§Examples

use d_engine_core::config::LeaseConfig;

// Default: disabled
let config = LeaseConfig::default();
assert!(!config.enabled);

// Enable with defaults
let config = LeaseConfig {
    enabled: true,
    ..Default::default()
};
assert_eq!(config.interval_ms, 1000);

Fields§

§enabled: bool

Enable TTL feature

  • true: Initialize lease manager + start background cleanup worker
  • false: No TTL support, reject requests with ttl_secs > 0

Default: false (zero overhead when TTL not needed)

§interval_ms: u64

Background cleanup interval in milliseconds

How often the background worker wakes up to scan and delete expired keys.

Range: 100-3600000 (100ms to 1 hour) Default: 1000 (1 second)

Tuning guide:

  • 1000ms (default): Balanced for most workloads
  • 100-500ms: Aggressive cleanup for memory-sensitive apps
  • 5000-10000ms: Relaxed cleanup for low TTL usage

Only used when enabled = true

§max_cleanup_duration_ms: u64

Maximum cleanup duration per cycle (milliseconds)

Limits how long a single cleanup cycle can run to prevent excessive CPU usage in the background worker.

Range: 1-100ms Default: 1ms

Tuning guide:

  • 1ms (default): Safe for latency-sensitive apps
  • 5-10ms: Aggressive cleanup when backlog exists
  • 10ms: Not recommended (can impact foreground operations)

Only used when enabled = true

Implementations§

Source§

impl LeaseConfig

Source

pub fn validate(&self) -> Result<()>

Validates configuration parameters

Returns error if:

  • interval_ms is out of range (100-3600000)
  • max_cleanup_duration_ms is out of range (1-100)

Trait Implementations§

Source§

impl Clone for LeaseConfig

Source§

fn clone(&self) -> LeaseConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LeaseConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LeaseConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for LeaseConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for LeaseConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> 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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,