Struct MemoryChecker

pub struct MemoryChecker { /* private fields */ }

Struct that composes a Config and MemoryStat and provides utility methods to validate whether memory is within limits.

The rationale behind such struct, is to be able to share across Relay the same logic for dealing with memory readings. It’s decoupled from MemoryStat because it’s just a layer on top that decides how memory readings are interpreted.

Implementations

impl MemoryChecker

pub fn new(memory_stat: MemoryStat, config: Arc<Config>) -> Self

Create an instance of MemoryChecker.

pub fn check_memory_percent(&self) -> MemoryCheck

Checks if the used percentage of memory is below the specified threshold.

pub fn check_memory_bytes(&self) -> MemoryCheck

Checks if the used memory (in bytes) is below the specified threshold.

pub fn check_memory(&self) -> MemoryCheck

Checks if the used memory is below both percentage and bytes thresholds.

This is the function that should be mainly used for checking whether of not Relay has enough memory.

Trait Implementations

impl Clone for MemoryChecker

fn clone(&self) -> MemoryChecker

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemoryChecker

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.