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

use crate::{
  commands,
  interfaces::{ClientLike, RedisResult},
  types::{MemoryStats, RedisKey},
};

/// Functions that implement the [memory](https://redis.io/commands#server) interface.
#[async_trait]
pub trait MemoryInterface: ClientLike + Sized {
  /// The MEMORY DOCTOR command reports about different memory-related issues that the Redis server experiences, and
  /// advises about possible remedies.
  ///
  /// <https://redis.io/commands/memory-doctor>
  async fn memory_doctor(&self) -> RedisResult<String> {
    commands::memory::memory_doctor(self).await?.convert()
  }

  /// The MEMORY MALLOC-STATS command provides an internal statistics report from the memory allocator.
  ///
  /// <https://redis.io/commands/memory-malloc-stats>
  async fn memory_malloc_stats(&self) -> RedisResult<String> {
    commands::memory::memory_malloc_stats(self).await?.convert()
  }

  /// The MEMORY PURGE command attempts to purge dirty pages so these can be reclaimed by the allocator.
  ///
  /// <https://redis.io/commands/memory-purge>
  async fn memory_purge(&self) -> RedisResult<()> {
    commands::memory::memory_purge(self).await
  }

  /// The MEMORY STATS command returns an Array reply about the memory usage of the server.
  ///
  /// <https://redis.io/commands/memory-stats>
  async fn memory_stats(&self) -> RedisResult<MemoryStats> {
    commands::memory::memory_stats(self).await
  }

  /// The MEMORY USAGE command reports the number of bytes that a key and its value require to be stored in RAM.
  ///
  /// <https://redis.io/commands/memory-usage>
  async fn memory_usage<K>(&self, key: K, samples: Option<u32>) -> RedisResult<Option<u64>>
  where
    K: Into<RedisKey> + Send,
  {
    into!(key);
    commands::memory::memory_usage(self, key, samples).await?.convert()
  }
}