grapple_db 0.2.1

Library with clients for different databases with lightweight interface
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! A module for collecting Redis models into key-value pairs.
//!
//! This module defines the `RedisModelCollector` trait, which is intended for types that can
//! aggregate multiple instances of a model implementing the `RedisModel` trait into a collection
//! of key-value pairs. This functionality is particularly useful for operations that involve
//! setting multiple values in Redis at once.
//!
//! # Overview
//!
//! The `RedisModelCollector` trait provides a method for converting a collection of models into
//! a vector of tuples, where each tuple contains a key and a value as strings. This is essential
//! for preparing data to be stored in Redis efficiently.
//!
//! # Associated Types
//!
//! * `M` - The type of the model that implements the `RedisModel` trait.
//!
//! # Methods
//!
//! ## collect
//!
//! Converts the implementing type into a vector of tuples, where each tuple contains a key
//! and a value as strings. This method is crucial for batch operations in Redis.
//!
//! # Example
//!
//! ```rust,no_run
//! use grapple_db::redis::RedisModel;
//! use grapple_db::redis::RedisModelCollector;
//! use grapple_db::redis::FromRedisValue;
//! use grapple_db::redis::macros::FromRedisValue;
//!
//! #[derive(Debug, serde::Serialize, serde::Deserialize, FromRedisValue)]
//! struct MyModel {
//!     key: String,
//!     value: String,
//! }
//!
//! impl RedisModel for MyModel {
//!     fn key(&self) -> String {
//!         self.key.clone()
//!     }
//! }
//!
//! struct MyModelCollector {
//!     models: Vec<MyModel>,
//! }
//!
//! impl RedisModelCollector<MyModel> for MyModelCollector {
//!     fn collect(&self) -> Vec<(String, String)> {
//!         self.models.iter()
//!             .map(|model| (model.key(), model.value().unwrap()))
//!             .collect()
//!     }
//! }
//! ```

use crate::redis::RedisModel;

/// A trait for collecting Redis models into a vector of key-value pairs.
///
/// The `RedisModelCollector` trait is designed for types that can aggregate multiple instances
/// of a model implementing the `RedisModel` trait into a collection of key-value pairs. This
/// is particularly useful for operations that involve setting multiple values in Redis at once.
///
/// # Associated Types
///
/// * `M` - The type of the model that implements the `RedisModel` trait.
///
/// # Methods
///
/// ## collect
///
/// Converts the implementing type into a vector of tuples, where each tuple contains a key
/// and a value as strings. This method is essential for preparing data to be stored in Redis.
///
/// # Example
///
/// ```rust,no_run
/// use grapple_db::redis::RedisModel;
/// use grapple_db::redis::RedisModelCollector;
/// use grapple_db::redis::FromRedisValue;
/// use grapple_db::redis::macros::FromRedisValue;
///
/// #[derive(Debug, serde::Serialize, serde::Deserialize, FromRedisValue)]
/// struct MyModel {
///     key: String,
///     value: String,
/// }
///
/// impl RedisModel for MyModel {
///     fn key(&self) -> String {
///         self.key.clone()
///     }
/// }
///
/// struct MyModelCollector {
///     models: Vec<MyModel>,
/// }
///
/// impl RedisModelCollector<MyModel> for MyModelCollector {
///     fn collect(&self) -> Vec<(String, String)> {
///         self.models.iter()
///             .map(|model| (model.key(), model.value().unwrap()))
///             .collect()
///     }
/// }
/// ```
pub trait RedisModelCollector<M>
where
    M: RedisModel,
{
    fn collect(&self) -> Vec<(String, String)>;
}

impl<'a, I, M> RedisModelCollector<M> for I
where
    M: RedisModel + 'a,
    I: AsRef<[&'a M]>,
{
    fn collect(&self) -> Vec<(String, String)> {
        self.as_ref()
            .iter()
            .filter_map(|m| {
                if let Ok(value) = m.value() {
                    Some((m.key().clone(), value.clone()))
                } else {
                    None
                }
            })
            .collect()
    }
}