Skip to main content

RedisDistributedLock

Struct RedisDistributedLock 

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

Redis 简单分布式锁。

锁语义:

  • 加锁:SET key value NX EX lease(value 为唯一标识,支持重入判断)
  • 释放:Lua 脚本校验 value 后 DEL(防止误删他人锁)

Implementations§

Source§

impl RedisDistributedLock

Source

pub fn new(client: Client, lease_milliseconds: i64) -> Result<Self, String>

构建 Redis 分布式锁(随机键名)。

§参数
  • client:redis 客户端
  • lease_milliseconds:锁租约时长(毫秒),必须大于 0
§错误

lease_milliseconds <= 0 时返回参数错误。

Source

pub fn with_key( client: Client, key: impl Into<String>, lease_milliseconds: i64, ) -> Result<Self, String>

构建指定键名的 Redis 分布式锁。

§参数
  • client:redis 客户端
  • key:锁键名
  • lease_milliseconds:锁租约时长(毫秒),必须大于 0
Source

pub fn lease_milliseconds(&self) -> i64

返回锁租约时长(毫秒)。

Source

pub fn key(&self) -> &str

返回锁键名。

Source

pub fn try_lock(&self) -> Result<Option<LockGuard>, RedisError>

尝试获取锁(非阻塞)。

§返回

获取成功返回 Ok(Some(guard))(Drop 时释放锁);连接失败返回错误。

Source

pub fn lock(&self, timeout: Option<Duration>) -> Result<LockGuard, String>

阻塞获取锁(轮询,对应 Java lock() 的 1 秒重试)。

§参数
  • timeout:总超时;None 为无限等待
§返回

获取成功返回 guard;超时或错误返回错误信息。

Trait Implementations§

Source§

impl Clone for RedisDistributedLock

Source§

fn clone(&self) -> RedisDistributedLock

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

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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 = !

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