Struct UsageInformation

pub struct UsageInformation { /* private fields */ }

A struct that keeps the records for all tracked objects.

Implementations

impl UsageInformation

pub fn add(&mut self, name: &String) -> Result<(), UsageTrackerError>

Adds a new object to keep track of.

Possible errors

• UsageTrackerError::ObjectAlreadyTracked

pub fn clear(&mut self)

Removes all objects permanently.

pub fn list(&self) -> Vec<&String>

Provides a vector with all existing keys.

pub fn list_verbose(&self) -> &BTreeMap<String, Usages>

Provides read access to all stored data.

pub fn load_usage_information_from_ron_file<R>( rdr: R, ) -> Result<Self, UsageTrackerError>

where R: Read,

👎Deprecated since 0.2: please only use this function if you have to load files from v0.1

Loads a UsageInformation object from a RON file.

Explanation

With v0.2, the data layout was changed. To make the transition from v0.1 easier for users, this function was created. It is able to read the RON files produced by v0.1 and convert them into the data structure of v0.2.

Deprecation

If it still exists by then, v1.0 will see this function removed.

Possible errors

• UsageTrackerError::FileLoadErrorRon

pub fn new() -> Self

Creates a new, empty UsageInformation object.

pub fn prune( &mut self, name: &String, before: &Option<DateTime<Utc>>, ) -> Result<(), UsageTrackerError>

Removes usages from an object.

If before is None, all usages are removed. Otherwise, only usages before before are removed.

Possible errors:

• UsageTrackerError::ObjectNotTracked

pub fn record_use( &mut self, name: &String, add_if_new: bool, ) -> Result<(), UsageTrackerError>

Records a new usage of an object.

Possible errors

• UsageTrackerError::ObjectNotTracked

pub fn remove(&mut self, name: &String)

Removes a currently tracked object permanently.

pub fn usage( &self, name: &String, time_frame: &Duration, ) -> Result<f64, UsageTrackerError>

Calculates the number of usages of the specified object within the specified amount of time.

This works by calculating how much the specified time frame is in comparison to the time since the oldest recorded usage. This relationship is the multiplied by the number of total uses, to calculate a specific number.

Possible errors

• UsageTrackerError::ObjectNeverUsed
• UsageTrackerError::ObjectNotTracked

pub fn usages(&self, name: &String) -> Result<&Usages, UsageTrackerError>

Provides the usages for a specific object.

Possible errors

• UsageTrackerError::ObjectNotTracked

Trait Implementations

impl Clone for UsageInformation

fn clone(&self) -> UsageInformation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UsageInformation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageInformation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UsageInformation

fn eq(&self, other: &UsageInformation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for UsageInformation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for UsageInformation

impl StructuralPartialEq for UsageInformation