foundation-ur 0.4.0

Implementation of Blockchain Common's Uniform Resources (UR) standard, with static memory allocation for embedded devices while also allowing to use dynamic memory allocation for platforms with more resources.
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
48
49
50
51
52
53
54
55
56
57

// SPDX-FileCopyrightText: © 2023 Foundation Devices, Inc. <hello@foundationdevices.com>
// SPDX-FileCopyrightText: © 2020 Dominik Spicher <dominikspicher@gmail.com>
// SPDX-License-Identifier: MIT

/// A double-ended queue.
pub trait Deque<T>: Default {
    /// Push an element on the back of the queue.
    fn push_back(&mut self, item: T);

    /// Push an element on the front of the queue.
    fn pop_front(&mut self) -> Option<T>;

    /// Remove all the elements.
    fn clear(&mut self);

    /// Returns `true` if the queue is empty.
    fn is_empty(&self) -> bool;
}

#[cfg(feature = "alloc")]
impl<T> Deque<T> for alloc::collections::VecDeque<T> {
    fn push_back(&mut self, value: T) {
        alloc::collections::VecDeque::push_back(self, value);
    }

    fn pop_front(&mut self) -> Option<T> {
        alloc::collections::VecDeque::pop_front(self)
    }

    fn clear(&mut self) {
        alloc::collections::VecDeque::clear(self)
    }

    fn is_empty(&self) -> bool {
        alloc::collections::VecDeque::is_empty(self)
    }
}

impl<T, const N: usize> Deque<T> for heapless::Deque<T, N> {
    fn push_back(&mut self, value: T) {
        if heapless::Deque::push_back(self, value).is_err() {
            panic!("push past allocated capacity")
        }
    }

    fn pop_front(&mut self) -> Option<T> {
        heapless::Deque::pop_front(self)
    }

    fn clear(&mut self) {
        heapless::Deque::clear(self)
    }

    fn is_empty(&self) -> bool {
        heapless::Deque::is_empty(self)
    }
}