dlock 0.2.0

A lease based distributed lock with support for fencing tokens
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

// SPDX-FileCopyrightText: 2025 Abe Kohandel <abe@kodebooth.com>
// SPDX-License-Identifier: MIT

use std::{fmt::Debug, time::Duration};

use crate::error::DLockError;

#[cfg(feature = "dynamodb")]
pub mod dynamodb;

/// `Provider` is a trait that abstracts the backend specific details of the
/// lock acquisition mechanism.
#[trait_variant::make(Provider: Send)]
pub trait LocalProvider: Clone {
    type T;
    type L: Lease<Self::L, Self::T>;
    type R: Clone;

    async fn acquire(
        &self,
        name: &str,
        owner: &str,
        duration: &Duration,
        retry: Option<Self::R>,
    ) -> Result<Self::L, DLockError<Self::R>>;
}

/// `Lease` is a trait that abstracts the backend specific details of the
/// lock renewal and release mechanism.
#[trait_variant::make(Lease: Send)]
pub trait LocalLease<L, T>: Debug {
    async fn release(&self) -> Result<(), DLockError>;
    async fn renew(&self) -> Result<L, DLockError>;

    fn token(&self) -> T;
}