rs-zero 0.2.8

Rust-first microservice framework inspired by go-zero engineering practices
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use std::time::Duration;

use crate::{
    cache_redis::{RedisBreakerConfig, RedisCacheConfig},
    lock::{LockError, LockResult},
};

/// Redis distributed lock configuration.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RedisLockConfig {
    /// Redis connection and command settings.
    pub redis: RedisCacheConfig,
    /// Namespace prefix for lock keys.
    pub namespace: String,
    /// Timeout for acquire and release commands.
    pub command_timeout: Duration,
    /// Optional circuit breaker protecting lock operations.
    pub breaker: RedisBreakerConfig,
    /// Whether Redis Cluster lock keys must contain a non-empty hash tag.
    pub require_cluster_hash_tag: bool,
}

impl Default for RedisLockConfig {
    fn default() -> Self {
        Self {
            redis: RedisCacheConfig::default(),
            namespace: "rs-zero:lock".to_string(),
            command_timeout: Duration::from_secs(2),
            breaker: RedisBreakerConfig::default(),
            require_cluster_hash_tag: true,
        }
    }
}

impl RedisLockConfig {
    /// Returns production-oriented Redis lock defaults.
    pub fn go_zero_defaults() -> Self {
        Self {
            breaker: RedisBreakerConfig::go_zero_defaults(),
            ..Self::default()
        }
    }

    /// Validates configuration values that can be checked locally.
    pub fn validate(&self) -> LockResult<()> {
        self.redis.validate()?;
        if self.namespace.trim().is_empty() {
            return Err(LockError::InvalidConfig(
                "redis lock namespace is required".to_string(),
            ));
        }
        if self.command_timeout.is_zero() {
            return Err(LockError::InvalidConfig(
                "redis lock command_timeout must be greater than zero".to_string(),
            ));
        }
        Ok(())
    }
}