-
-
Notifications
You must be signed in to change notification settings - Fork 69
/
cache.rs
2194 lines (1966 loc) · 77 KB
/
cache.rs
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use super::{
value_initializer::{InitResult, ValueInitializer},
CacheBuilder, ConcurrentCacheExt,
};
use crate::{
common::concurrent::{
constants::{MAX_SYNC_REPEATS, WRITE_RETRY_INTERVAL_MICROS},
housekeeper::InnerSync,
Weigher, WriteOp,
},
sync::{Iter, PredicateId},
sync_base::base_cache::{BaseCache, HouseKeeperArc},
Policy, PredicateError,
};
#[cfg(feature = "unstable-debug-counters")]
use crate::common::concurrent::debug_counters::CacheDebugStats;
use crossbeam_channel::{Sender, TrySendError};
use std::{
any::TypeId,
borrow::Borrow,
collections::hash_map::RandomState,
fmt,
future::Future,
hash::{BuildHasher, Hash},
sync::Arc,
time::Duration,
};
/// A thread-safe, futures-aware concurrent in-memory cache.
///
/// `Cache` supports full concurrency of retrievals and a high expected concurrency
/// for updates. It can be accessed inside and outside of asynchronous contexts.
///
/// `Cache` utilizes a lock-free concurrent hash table as the central key-value
/// storage. `Cache` performs a best-effort bounding of the map using an entry
/// replacement algorithm to determine which entries to evict when the capacity is
/// exceeded.
///
/// To use this cache, enable a crate feature called "future".
///
/// # Examples
///
/// Cache entries are manually added using an insert method, and are stored in the
/// cache until either evicted or manually invalidated:
///
/// - Inside an async context (`async fn` or `async` block), use
/// [`insert`](#method.insert), [`get_with`](#method.get_with)
/// or [`invalidate`](#method.invalidate) methods for updating the cache and `await`
/// them.
/// - Outside any async context, use [`blocking`](#method.blocking) method to access
/// blocking version of [`insert`](./struct.BlockingOp.html#method.insert) or
/// [`invalidate`](struct.BlockingOp.html#method.invalidate) methods.
///
/// Here's an example of reading and updating a cache by using multiple asynchronous
/// tasks with [Tokio][tokio-crate] runtime:
///
/// [tokio-crate]: https://crates.io/crates/tokio
///
///```rust
/// // Cargo.toml
/// //
/// // [dependencies]
/// // moka = { version = "0.8", features = ["future"] }
/// // tokio = { version = "1", features = ["rt-multi-thread", "macros" ] }
/// // futures-util = "0.3"
///
/// use moka::future::Cache;
///
/// #[tokio::main]
/// async fn main() {
/// const NUM_TASKS: usize = 16;
/// const NUM_KEYS_PER_TASK: usize = 64;
///
/// fn value(n: usize) -> String {
/// format!("value {}", n)
/// }
///
/// // Create a cache that can store up to 10,000 entries.
/// let cache = Cache::new(10_000);
///
/// // Spawn async tasks and write to and read from the cache.
/// let tasks: Vec<_> = (0..NUM_TASKS)
/// .map(|i| {
/// // To share the same cache across the async tasks, clone it.
/// // This is a cheap operation.
/// let my_cache = cache.clone();
/// let start = i * NUM_KEYS_PER_TASK;
/// let end = (i + 1) * NUM_KEYS_PER_TASK;
///
/// tokio::spawn(async move {
/// // Insert 64 entries. (NUM_KEYS_PER_TASK = 64)
/// for key in start..end {
/// // insert() is an async method, so await it.
/// my_cache.insert(key, value(key)).await;
/// // get() returns Option<String>, a clone of the stored value.
/// assert_eq!(my_cache.get(&key), Some(value(key)));
/// }
///
/// // Invalidate every 4 element of the inserted entries.
/// for key in (start..end).step_by(4) {
/// // invalidate() is an async method, so await it.
/// my_cache.invalidate(&key).await;
/// }
/// })
/// })
/// .collect();
///
/// // Wait for all tasks to complete.
/// futures_util::future::join_all(tasks).await;
///
/// // Verify the result.
/// for key in 0..(NUM_TASKS * NUM_KEYS_PER_TASK) {
/// if key % 4 == 0 {
/// assert_eq!(cache.get(&key), None);
/// } else {
/// assert_eq!(cache.get(&key), Some(value(key)));
/// }
/// }
/// }
/// ```
///
/// If you want to atomically initialize and insert a value when the key is not
/// present, you might want to check other insertion methods
/// [`get_with`](#method.get_with) and
/// [`try_get_with`](#method.try_get_with).
///
/// # Avoiding to clone the value at `get`
///
/// The return type of `get` method is `Option<V>` instead of `Option<&V>`. Every
/// time `get` is called for an existing key, it creates a clone of the stored value
/// `V` and returns it. This is because the `Cache` allows concurrent updates from
/// threads so a value stored in the cache can be dropped or replaced at any time by
/// any other thread. `get` cannot return a reference `&V` as it is impossible to
/// guarantee the value outlives the reference.
///
/// If you want to store values that will be expensive to clone, wrap them by
/// `std::sync::Arc` before storing in a cache. [`Arc`][rustdoc-std-arc] is a
/// thread-safe reference-counted pointer and its `clone()` method is cheap.
///
/// [rustdoc-std-arc]: https://doc.rust-lang.org/stable/std/sync/struct.Arc.html
///
/// # Size-based Eviction
///
/// ```rust
/// // Cargo.toml
/// //
/// // [dependencies]
/// // moka = { version = "0.8", features = ["future"] }
/// // tokio = { version = "1", features = ["rt-multi-thread", "macros" ] }
/// // futures-util = "0.3"
///
/// use std::convert::TryInto;
/// use moka::future::Cache;
///
/// #[tokio::main]
/// async fn main() {
/// // Evict based on the number of entries in the cache.
/// let cache = Cache::builder()
/// // Up to 10,000 entries.
/// .max_capacity(10_000)
/// // Create the cache.
/// .build();
/// cache.insert(1, "one".to_string()).await;
///
/// // Evict based on the byte length of strings in the cache.
/// let cache = Cache::builder()
/// // A weigher closure takes &K and &V and returns a u32
/// // representing the relative size of the entry.
/// .weigher(|_key, value: &String| -> u32 {
/// value.len().try_into().unwrap_or(u32::MAX)
/// })
/// // This cache will hold up to 32MiB of values.
/// .max_capacity(32 * 1024 * 1024)
/// .build();
/// cache.insert(2, "two".to_string()).await;
/// }
/// ```
///
/// If your cache should not grow beyond a certain size, use the `max_capacity`
/// method of the [`CacheBuilder`][builder-struct] to set the upper bound. The cache
/// will try to evict entries that have not been used recently or very often.
///
/// At the cache creation time, a weigher closure can be set by the `weigher` method
/// of the `CacheBuilder`. A weigher closure takes `&K` and `&V` as the arguments and
/// returns a `u32` representing the relative size of the entry:
///
/// - If the `weigher` is _not_ set, the cache will treat each entry has the same
/// size of `1`. This means the cache will be bounded by the number of entries.
/// - If the `weigher` is set, the cache will call the weigher to calculate the
/// weighted size (relative size) on an entry. This means the cache will be bounded
/// by the total weighted size of entries.
///
/// Note that weighted sizes are not used when making eviction selections.
///
/// [builder-struct]: ./struct.CacheBuilder.html
///
/// # Time-based Expirations
///
/// `Cache` supports the following expiration policies:
///
/// - **Time to live**: A cached entry will be expired after the specified duration
/// past from `insert`.
/// - **Time to idle**: A cached entry will be expired after the specified duration
/// past from `get` or `insert`.
///
/// ```rust
/// // Cargo.toml
/// //
/// // [dependencies]
/// // moka = { version = "0.8", features = ["future"] }
/// // tokio = { version = "1", features = ["rt-multi-thread", "macros" ] }
/// // futures-util = "0.3"
///
/// use moka::future::Cache;
/// use std::time::Duration;
///
/// #[tokio::main]
/// async fn main() {
/// let cache = Cache::builder()
/// // Time to live (TTL): 30 minutes
/// .time_to_live(Duration::from_secs(30 * 60))
/// // Time to idle (TTI): 5 minutes
/// .time_to_idle(Duration::from_secs( 5 * 60))
/// // Create the cache.
/// .build();
///
/// // This entry will expire after 5 minutes (TTI) if there is no get().
/// cache.insert(0, "zero").await;
///
/// // This get() will extend the entry life for another 5 minutes.
/// cache.get(&0);
///
/// // Even though we keep calling get(), the entry will expire
/// // after 30 minutes (TTL) from the insert().
/// }
/// ```
///
/// # Thread Safety
///
/// All methods provided by the `Cache` are considered thread-safe, and can be safely
/// accessed by multiple concurrent threads.
///
/// - `Cache<K, V, S>` requires trait bounds `Send`, `Sync` and `'static` for `K`
/// (key), `V` (value) and `S` (hasher state).
/// - `Cache<K, V, S>` will implement `Send` and `Sync`.
///
/// # Sharing a cache across asynchronous tasks
///
/// To share a cache across async tasks (or OS threads), do one of the followings:
///
/// - Create a clone of the cache by calling its `clone` method and pass it to other
/// task.
/// - Wrap the cache by a `sync::OnceCell` or `sync::Lazy` from
/// [once_cell][once-cell-crate] create, and set it to a `static` variable.
///
/// Cloning is a cheap operation for `Cache` as it only creates thread-safe
/// reference-counted pointers to the internal data structures.
///
/// [once-cell-crate]: https://crates.io/crates/once_cell
///
/// # Hashing Algorithm
///
/// By default, `Cache` uses a hashing algorithm selected to provide resistance
/// against HashDoS attacks. It will be the same one used by
/// `std::collections::HashMap`, which is currently SipHash 1-3.
///
/// While SipHash's performance is very competitive for medium sized keys, other
/// hashing algorithms will outperform it for small keys such as integers as well as
/// large keys such as long strings. However those algorithms will typically not
/// protect against attacks such as HashDoS.
///
/// The hashing algorithm can be replaced on a per-`Cache` basis using the
/// [`build_with_hasher`][build-with-hasher-method] method of the
/// `CacheBuilder`. Many alternative algorithms are available on crates.io, such
/// as the [aHash][ahash-crate] crate.
///
/// [build-with-hasher-method]: ./struct.CacheBuilder.html#method.build_with_hasher
/// [ahash-crate]: https://crates.io/crates/ahash
///
pub struct Cache<K, V, S = RandomState> {
base: BaseCache<K, V, S>,
value_initializer: Arc<ValueInitializer<K, V, S>>,
}
// TODO: https://github.com/moka-rs/moka/issues/54
#[allow(clippy::non_send_fields_in_send_ty)]
unsafe impl<K, V, S> Send for Cache<K, V, S>
where
K: Send + Sync,
V: Send + Sync,
S: Send,
{
}
unsafe impl<K, V, S> Sync for Cache<K, V, S>
where
K: Send + Sync,
V: Send + Sync,
S: Sync,
{
}
// NOTE: We cannot do `#[derive(Clone)]` because it will add `Clone` bound to `K`.
impl<K, V, S> Clone for Cache<K, V, S> {
/// Makes a clone of this shared cache.
///
/// This operation is cheap as it only creates thread-safe reference counted
/// pointers to the shared internal data structures.
fn clone(&self) -> Self {
Self {
base: self.base.clone(),
value_initializer: Arc::clone(&self.value_initializer),
}
}
}
impl<K, V, S> fmt::Debug for Cache<K, V, S>
where
K: fmt::Debug + Eq + Hash + Send + Sync + 'static,
V: fmt::Debug + Clone + Send + Sync + 'static,
// TODO: Remove these bounds from S.
S: BuildHasher + Clone + Send + Sync + 'static,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut d_map = f.debug_map();
for (k, v) in self.iter() {
d_map.entry(&k, &v);
}
d_map.finish()
}
}
impl<K, V, S> Cache<K, V, S> {
/// Returns a read-only cache policy of this cache.
///
/// At this time, cache policy cannot be modified after cache creation.
/// A future version may support to modify it.
pub fn policy(&self) -> Policy {
self.base.policy()
}
/// Returns an approximate number of entries in this cache.
///
/// The value returned is _an estimate_; the actual count may differ if there are
/// concurrent insertions or removals, or if some entries are pending removal due
/// to expiration. This inaccuracy can be mitigated by performing a `sync()`
/// first.
///
/// # Example
///
/// ```rust
/// // Cargo.toml
/// //
/// // [dependencies]
/// // moka = { version = "0.8", features = ["future"] }
/// // tokio = { version = "1", features = ["rt-multi-thread", "macros" ] }
/// use moka::future::Cache;
///
/// #[tokio::main]
/// async fn main() {
/// let cache = Cache::new(10);
/// cache.insert('n', "Netherland Dwarf").await;
/// cache.insert('l', "Lop Eared").await;
/// cache.insert('d', "Dutch").await;
///
/// // Ensure an entry exists.
/// assert!(cache.contains_key(&'n'));
///
/// // However, followings may print stale number zeros instead of threes.
/// println!("{}", cache.entry_count()); // -> 0
/// println!("{}", cache.weighted_size()); // -> 0
///
/// // To mitigate the inaccuracy, bring `ConcurrentCacheExt` trait to
/// // the scope so we can use `sync` method.
/// use moka::future::ConcurrentCacheExt;
/// // Call `sync` to run pending internal tasks.
/// cache.sync();
///
/// // Followings will print the actual numbers.
/// println!("{}", cache.entry_count()); // -> 3
/// println!("{}", cache.weighted_size()); // -> 3
/// }
/// ```
///
pub fn entry_count(&self) -> u64 {
self.base.entry_count()
}
/// Returns an approximate total weighted size of entries in this cache.
///
/// The value returned is _an estimate_; the actual size may differ if there are
/// concurrent insertions or removals, or if some entries are pending removal due
/// to expiration. This inaccuracy can be mitigated by performing a `sync()`
/// first. See [`entry_count`](#method.entry_count) for a sample code.
pub fn weighted_size(&self) -> u64 {
self.base.weighted_size()
}
#[cfg(feature = "unstable-debug-counters")]
#[cfg_attr(docsrs, doc(cfg(feature = "unstable-debug-counters")))]
pub fn debug_stats(&self) -> CacheDebugStats {
self.base.debug_stats()
}
}
impl<K, V> Cache<K, V, RandomState>
where
K: Hash + Eq + Send + Sync + 'static,
V: Clone + Send + Sync + 'static,
{
/// Constructs a new `Cache<K, V>` that will store up to the `max_capacity`.
///
/// To adjust various configuration knobs such as `initial_capacity` or
/// `time_to_live`, use the [`CacheBuilder`][builder-struct].
///
/// [builder-struct]: ./struct.CacheBuilder.html
pub fn new(max_capacity: u64) -> Self {
let build_hasher = RandomState::default();
Self::with_everything(
Some(max_capacity),
None,
build_hasher,
None,
None,
None,
false,
)
}
/// Returns a [`CacheBuilder`][builder-struct], which can builds a `Cache` with
/// various configuration knobs.
///
/// [builder-struct]: ./struct.CacheBuilder.html
pub fn builder() -> CacheBuilder<K, V, Cache<K, V, RandomState>> {
CacheBuilder::default()
}
}
impl<K, V, S> Cache<K, V, S>
where
K: Hash + Eq + Send + Sync + 'static,
V: Clone + Send + Sync + 'static,
S: BuildHasher + Clone + Send + Sync + 'static,
{
pub(crate) fn with_everything(
max_capacity: Option<u64>,
initial_capacity: Option<usize>,
build_hasher: S,
weigher: Option<Weigher<K, V>>,
time_to_live: Option<Duration>,
time_to_idle: Option<Duration>,
invalidator_enabled: bool,
) -> Self {
Self {
base: BaseCache::new(
max_capacity,
initial_capacity,
build_hasher.clone(),
weigher,
time_to_live,
time_to_idle,
invalidator_enabled,
),
value_initializer: Arc::new(ValueInitializer::with_hasher(build_hasher)),
}
}
/// Returns `true` if the cache contains a value for the key.
///
/// Unlike the `get` method, this method is not considered a cache read operation,
/// so it does not update the historic popularity estimator or reset the idle
/// timer for the key.
///
/// The key may be any borrowed form of the cache's key type, but `Hash` and `Eq`
/// on the borrowed form _must_ match those for the key type.
pub fn contains_key<Q>(&self, key: &Q) -> bool
where
Arc<K>: Borrow<Q>,
Q: Hash + Eq + ?Sized,
{
self.base.contains_key_with_hash(key, self.base.hash(key))
}
/// Returns a _clone_ of the value corresponding to the key.
///
/// If you want to store values that will be expensive to clone, wrap them by
/// `std::sync::Arc` before storing in a cache. [`Arc`][rustdoc-std-arc] is a
/// thread-safe reference-counted pointer and its `clone()` method is cheap.
///
/// The key may be any borrowed form of the cache's key type, but `Hash` and `Eq`
/// on the borrowed form _must_ match those for the key type.
///
/// [rustdoc-std-arc]: https://doc.rust-lang.org/stable/std/sync/struct.Arc.html
pub fn get<Q>(&self, key: &Q) -> Option<V>
where
Arc<K>: Borrow<Q>,
Q: Hash + Eq + ?Sized,
{
self.base.get_with_hash(key, self.base.hash(key))
}
/// Deprecated, replaced with [`get_with`](#method.get_with)
#[deprecated(since = "0.8.0", note = "Replaced with `get_with`")]
pub async fn get_or_insert_with(&self, key: K, init: impl Future<Output = V>) -> V {
self.get_with(key, init).await
}
/// Deprecated, replaced with [`try_get_with`](#method.try_get_with)
#[deprecated(since = "0.8.0", note = "Replaced with `try_get_with`")]
pub async fn get_or_try_insert_with<F, E>(&self, key: K, init: F) -> Result<V, Arc<E>>
where
F: Future<Output = Result<V, E>>,
E: Send + Sync + 'static,
{
self.try_get_with(key, init).await
}
/// Ensures the value of the key exists by inserting the output of the `init`
/// future if not exist, and returns a _clone_ of the value.
///
/// This method prevents to resolve the init future multiple times on the same
/// key even if the method is concurrently called by many async tasks; only one
/// of the calls resolves its future, and other calls wait for that future to
/// complete.
///
/// # Example
///
/// ```rust
/// // Cargo.toml
/// //
/// // [dependencies]
/// // moka = { version = "0.8", features = ["future"] }
/// // futures-util = "0.3"
/// // tokio = { version = "1", features = ["rt-multi-thread", "macros" ] }
/// use moka::future::Cache;
/// use std::sync::Arc;
///
/// #[tokio::main]
/// async fn main() {
/// const TEN_MIB: usize = 10 * 1024 * 1024; // 10MiB
/// let cache = Cache::new(100);
///
/// // Spawn four async tasks.
/// let tasks: Vec<_> = (0..4_u8)
/// .map(|task_id| {
/// let my_cache = cache.clone();
/// tokio::spawn(async move {
/// println!("Task {} started.", task_id);
///
/// // Insert and get the value for key1. Although all four async tasks
/// // will call `get_with` at the same time, the `init` async
/// // block must be resolved only once.
/// let value = my_cache
/// .get_with("key1", async move {
/// println!("Task {} inserting a value.", task_id);
/// Arc::new(vec![0u8; TEN_MIB])
/// })
/// .await;
///
/// // Ensure the value exists now.
/// assert_eq!(value.len(), TEN_MIB);
/// assert!(my_cache.get(&"key1").is_some());
///
/// println!("Task {} got the value. (len: {})", task_id, value.len());
/// })
/// })
/// .collect();
///
/// // Run all tasks concurrently and wait for them to complete.
/// futures_util::future::join_all(tasks).await;
/// }
/// ```
///
/// **A Sample Result**
///
/// - The `init` future (async black) was resolved exactly once by task 3.
/// - Other tasks were blocked until task 3 inserted the value.
///
/// ```console
/// Task 0 started.
/// Task 3 started.
/// Task 1 started.
/// Task 2 started.
/// Task 3 inserting a value.
/// Task 3 got the value. (len: 10485760)
/// Task 0 got the value. (len: 10485760)
/// Task 1 got the value. (len: 10485760)
/// Task 2 got the value. (len: 10485760)
/// ```
///
/// # Panics
///
/// This method panics when the `init` future has been panicked. When it happens,
/// only the caller whose `init` future panicked will get the panic (e.g. only
/// task 3 in the above sample). If there are other calls in progress (e.g. task
/// 0, 1 and 2 above), this method will restart and resolve one of the remaining
/// `init` futures.
///
pub async fn get_with(&self, key: K, init: impl Future<Output = V>) -> V {
let hash = self.base.hash(&key);
let key = Arc::new(key);
let replace_if = None as Option<fn(&V) -> bool>;
self.get_or_insert_with_hash_and_fun(key, hash, init, replace_if)
.await
}
/// Works like [`get_with`](#method.get_with), but takes an additional
/// `replace_if` closure.
///
/// This method will resolve the `init` feature and insert the output to the
/// cache when:
///
/// - The key does not exist.
/// - Or, `replace_if` closure returns `true`.
pub async fn get_with_if(
&self,
key: K,
init: impl Future<Output = V>,
replace_if: impl FnMut(&V) -> bool,
) -> V {
let hash = self.base.hash(&key);
let key = Arc::new(key);
self.get_or_insert_with_hash_and_fun(key, hash, init, Some(replace_if))
.await
}
/// Try to ensure the value of the key exists by inserting an `Ok` output of the
/// init future if not exist, and returns a _clone_ of the value or the `Err`
/// produced by the future.
///
/// This method prevents to resolve the init future multiple times on the same
/// key even if the method is concurrently called by many async tasks; only one
/// of the calls resolves its future (as long as these futures return the same
/// error type), and other calls wait for that future to complete.
///
/// # Example
///
/// ```rust
/// // Cargo.toml
/// //
/// // [dependencies]
/// // moka = { version = "0.8", features = ["future"] }
/// // futures-util = "0.3"
/// // reqwest = "0.11"
/// // tokio = { version = "1", features = ["rt-multi-thread", "macros" ] }
/// use moka::future::Cache;
///
/// // This async function tries to get HTML from the given URI.
/// async fn get_html(task_id: u8, uri: &str) -> Result<String, reqwest::Error> {
/// println!("get_html() called by task {}.", task_id);
/// Ok(reqwest::get(uri).await?.text().await?)
/// }
///
/// #[tokio::main]
/// async fn main() {
/// let cache = Cache::new(100);
///
/// // Spawn four async tasks.
/// let tasks: Vec<_> = (0..4_u8)
/// .map(|task_id| {
/// let my_cache = cache.clone();
/// tokio::spawn(async move {
/// println!("Task {} started.", task_id);
///
/// // Try to insert and get the value for key1. Although
/// // all four async tasks will call `try_get_with`
/// // at the same time, get_html() must be called only once.
/// let value = my_cache
/// .try_get_with(
/// "key1",
/// get_html(task_id, "https://www.rust-lang.org"),
/// ).await;
///
/// // Ensure the value exists now.
/// assert!(value.is_ok());
/// assert!(my_cache.get(&"key1").is_some());
///
/// println!(
/// "Task {} got the value. (len: {})",
/// task_id,
/// value.unwrap().len()
/// );
/// })
/// })
/// .collect();
///
/// // Run all tasks concurrently and wait for them to complete.
/// futures_util::future::join_all(tasks).await;
/// }
/// ```
///
/// **A Sample Result**
///
/// - `get_html()` was called exactly once by task 2.
/// - Other tasks were blocked until task 2 inserted the value.
///
/// ```console
/// Task 1 started.
/// Task 0 started.
/// Task 2 started.
/// Task 3 started.
/// get_html() called by task 2.
/// Task 2 got the value. (len: 19419)
/// Task 1 got the value. (len: 19419)
/// Task 0 got the value. (len: 19419)
/// Task 3 got the value. (len: 19419)
/// ```
///
/// # Panics
///
/// This method panics when the `init` future has been panicked. When it happens,
/// only the caller whose `init` future panicked will get the panic (e.g. only
/// task 2 in the above sample). If there are other calls in progress (e.g. task
/// 0, 1 and 3 above), this method will restart and resolve one of the remaining
/// `init` futures.
///
pub async fn try_get_with<F, E>(&self, key: K, init: F) -> Result<V, Arc<E>>
where
F: Future<Output = Result<V, E>>,
E: Send + Sync + 'static,
{
let hash = self.base.hash(&key);
let key = Arc::new(key);
self.get_or_try_insert_with_hash_and_fun(key, hash, init)
.await
}
/// Inserts a key-value pair into the cache.
///
/// If the cache has this key present, the value is updated.
pub async fn insert(&self, key: K, value: V) {
let hash = self.base.hash(&key);
let key = Arc::new(key);
self.insert_with_hash(key, hash, value).await
}
fn do_blocking_insert(&self, key: K, value: V) {
let hash = self.base.hash(&key);
let key = Arc::new(key);
let op = self.base.do_insert_with_hash(key, hash, value);
let hk = self.base.housekeeper.as_ref();
Self::blocking_schedule_write_op(&self.base.write_op_ch, op, hk).expect("Failed to insert");
}
/// Discards any cached value for the key.
///
/// The key may be any borrowed form of the cache's key type, but `Hash` and `Eq`
/// on the borrowed form _must_ match those for the key type.
pub async fn invalidate<Q>(&self, key: &Q)
where
Arc<K>: Borrow<Q>,
Q: Hash + Eq + ?Sized,
{
let hash = self.base.hash(key);
if let Some(kv) = self.base.remove_entry(key, hash) {
let op = WriteOp::Remove(kv);
let hk = self.base.housekeeper.as_ref();
Self::schedule_write_op(&self.base.write_op_ch, op, hk)
.await
.expect("Failed to remove");
}
}
fn do_blocking_invalidate<Q>(&self, key: &Q)
where
Arc<K>: Borrow<Q>,
Q: Hash + Eq + ?Sized,
{
let hash = self.base.hash(key);
if let Some(kv) = self.base.remove_entry(key, hash) {
let op = WriteOp::Remove(kv);
let hk = self.base.housekeeper.as_ref();
Self::blocking_schedule_write_op(&self.base.write_op_ch, op, hk)
.expect("Failed to remove");
}
}
/// Discards all cached values.
///
/// This method returns immediately and a background thread will evict all the
/// cached values inserted before the time when this method was called. It is
/// guaranteed that the `get` method must not return these invalidated values
/// even if they have not been evicted.
///
/// Like the `invalidate` method, this method does not clear the historic
/// popularity estimator of keys so that it retains the client activities of
/// trying to retrieve an item.
pub fn invalidate_all(&self) {
self.base.invalidate_all();
}
/// Discards cached values that satisfy a predicate.
///
/// `invalidate_entries_if` takes a closure that returns `true` or `false`. This
/// method returns immediately and a background thread will apply the closure to
/// each cached value inserted before the time when `invalidate_entries_if` was
/// called. If the closure returns `true` on a value, that value will be evicted
/// from the cache.
///
/// Also the `get` method will apply the closure to a value to determine if it
/// should have been invalidated. Therefore, it is guaranteed that the `get`
/// method must not return invalidated values.
///
/// Note that you must call
/// [`CacheBuilder::support_invalidation_closures`][support-invalidation-closures]
/// at the cache creation time as the cache needs to maintain additional internal
/// data structures to support this method. Otherwise, calling this method will
/// fail with a
/// [`PredicateError::InvalidationClosuresDisabled`][invalidation-disabled-error].
///
/// Like the `invalidate` method, this method does not clear the historic
/// popularity estimator of keys so that it retains the client activities of
/// trying to retrieve an item.
///
/// [support-invalidation-closures]: ./struct.CacheBuilder.html#method.support_invalidation_closures
/// [invalidation-disabled-error]: ../enum.PredicateError.html#variant.InvalidationClosuresDisabled
pub fn invalidate_entries_if<F>(&self, predicate: F) -> Result<PredicateId, PredicateError>
where
F: Fn(&K, &V) -> bool + Send + Sync + 'static,
{
self.base.invalidate_entries_if(Arc::new(predicate))
}
/// Creates an iterator visiting all key-value pairs in arbitrary order. The
/// iterator element type is `(Arc<K>, V)`, where `V` is a clone of a stored
/// value.
///
/// Iterators do not block concurrent reads and writes on the cache. An entry can
/// be inserted to, invalidated or evicted from a cache while iterators are alive
/// on the same cache.
///
/// Unlike the `get` method, visiting entries via an iterator do not update the
/// historic popularity estimator or reset idle timers for keys.
///
/// # Guarantees
///
/// In order to allow concurrent access to the cache, iterator's `next` method
/// does _not_ guarantee the following:
///
/// - It does not guarantee to return a key-value pair (an entry) if its key has
/// been inserted to the cache _after_ the iterator was created.
/// - Such an entry may or may not be returned depending on key's hash and
/// timing.
///
/// and the `next` method guarantees the followings:
///
/// - It guarantees not to return the same entry more than once.
/// - It guarantees not to return an entry if it has been removed from the cache
/// after the iterator was created.
/// - Note: An entry can be removed by following reasons:
/// - Manually invalidated.
/// - Expired (e.g. time-to-live).
/// - Evicted as the cache capacity exceeded.
///
/// # Examples
///
/// ```rust
/// // Cargo.toml
/// //
/// // [dependencies]
/// // moka = { version = "0.8.2", features = ["future"] }
/// // tokio = { version = "1", features = ["rt-multi-thread", "macros" ] }
/// use moka::future::Cache;
///
/// #[tokio::main]
/// async fn main() {
/// let cache = Cache::new(100);
/// cache.insert("Julia", 14).await;
///
/// let mut iter = cache.iter();
/// let (k, v) = iter.next().unwrap(); // (Arc<K>, V)
/// assert_eq!(*k, "Julia");
/// assert_eq!(v, 14);
///
/// assert!(iter.next().is_none());
/// }
/// ```
///
pub fn iter(&self) -> Iter<'_, K, V> {
use crate::sync_base::iter::ScanningGet;
Iter::with_single_cache_segment(&self.base, self.base.num_cht_segments())
}
/// Returns a `BlockingOp` for this cache. It provides blocking
/// [`insert`](./struct.BlockingOp.html#method.insert) and
/// [`invalidate`](struct.BlockingOp.html#method.invalidate) methods, which
/// can be called outside of asynchronous contexts.
pub fn blocking(&self) -> BlockingOp<'_, K, V, S> {
BlockingOp(self)
}
}
impl<'a, K, V, S> IntoIterator for &'a Cache<K, V, S>
where
K: Hash + Eq + Send + Sync + 'static,
V: Clone + Send + Sync + 'static,
S: BuildHasher + Clone + Send + Sync + 'static,
{
type Item = (Arc<K>, V);
type IntoIter = Iter<'a, K, V>;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
impl<K, V, S> ConcurrentCacheExt<K, V> for Cache<K, V, S>
where
K: Hash + Eq + Send + Sync + 'static,
V: Send + Sync + 'static,
S: BuildHasher + Clone + Send + Sync + 'static,
{
fn sync(&self) {
self.base.inner.sync(MAX_SYNC_REPEATS);
}
}
//
// private methods
//
impl<K, V, S> Cache<K, V, S>
where
K: Hash + Eq + Send + Sync + 'static,
V: Clone + Send + Sync + 'static,
S: BuildHasher + Clone + Send + Sync + 'static,
{
async fn get_or_insert_with_hash_and_fun(
&self,
key: Arc<K>,
hash: u64,
init: impl Future<Output = V>,
mut replace_if: Option<impl FnMut(&V) -> bool>,
) -> V {
match (self.base.get_with_hash(&key, hash), &mut replace_if) {
(Some(v), None) => return v,
(Some(v), Some(cond)) => {
if !cond(&v) {
return v;
};
}
_ => (),
}
match self
.value_initializer
.init_or_read(Arc::clone(&key), init)
.await
{
InitResult::Initialized(v) => {
self.insert_with_hash(Arc::clone(&key), hash, v.clone())
.await;
self.value_initializer
.remove_waiter(&key, TypeId::of::<()>());
v
}
InitResult::ReadExisting(v) => v,
InitResult::InitErr(_) => unreachable!(),
}
}
async fn get_or_try_insert_with_hash_and_fun<F, E>(
&self,
key: Arc<K>,
hash: u64,
init: F,
) -> Result<V, Arc<E>>
where
F: Future<Output = Result<V, E>>,
E: Send + Sync + 'static,
{
if let Some(v) = self.base.get_with_hash(&key, hash) {
return Ok(v);
}
match self
.value_initializer
.try_init_or_read(Arc::clone(&key), init)
.await
{
InitResult::Initialized(v) => {
let hash = self.base.hash(&key);
self.insert_with_hash(Arc::clone(&key), hash, v.clone())
.await;
self.value_initializer
.remove_waiter(&key, TypeId::of::<E>());
Ok(v)
}
InitResult::ReadExisting(v) => Ok(v),
InitResult::InitErr(e) => Err(e),
}
}
async fn insert_with_hash(&self, key: Arc<K>, hash: u64, value: V) {
let op = self.base.do_insert_with_hash(key, hash, value);