canfund 0.8.5

This Rust library provides a simple interface to monitor and add cycles to canisters on the Internet Computer.
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

use std::collections::VecDeque;

#[derive(Clone)]
pub struct ConsumptionHistory {
    /// The history of the consumed cycles.
    samples: VecDeque<u64>,
    /// The sum of the consumed cycles.
    sum: u64,
    /// The number of history elements to keep.
    window_size: usize,
}

impl ConsumptionHistory {
    /// Constructs a new ConsumptionHistory with the specified window size.
    pub fn new(window_size: usize) -> Self {
        Self {
            samples: VecDeque::with_capacity(window_size),
            sum: 0,
            window_size,
        }
    }

    /// Adds a new sample to the history.
    pub fn add_sample(&mut self, consumption: u64) {
        if self.window_size == 0 {
            return;
        }

        if self.samples.len() == self.window_size {
            let oldest_sample = self.samples.pop_front().unwrap();
            self.sum -= oldest_sample;
        }

        self.samples.push_back(consumption);

        self.sum += consumption;
    }

    /// Returns the average of the samples in the history.
    pub fn average(&self) -> u64 {
        if self.samples.is_empty() {
            return 0;
        }

        self.sum / self.samples.len() as u64
    }
}