bbqr 0.5.0

Implementaion of the bbqr spec in rust
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! File type enum for the different file types supported by the BBQr standard

use std::fmt::{self, Display, Formatter};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// The file type supported by the BBQr standard
pub enum FileType {
    Psbt,
    Transaction,
    Json,
    Cbor,
    UnicodeText,
    KeyTeleportReceiver,
    KeyTeleportSender,
    KeyTeleportPsbt,
}

impl FileType {
    pub fn from_byte(byte: u8) -> Option<FileType> {
        match byte {
            b'P' => Some(FileType::Psbt),
            b'T' => Some(FileType::Transaction),
            b'J' => Some(FileType::Json),
            b'C' => Some(FileType::Cbor),
            b'U' => Some(FileType::UnicodeText),
            b'R' => Some(FileType::KeyTeleportReceiver),
            b'S' => Some(FileType::KeyTeleportSender),
            b'E' => Some(FileType::KeyTeleportPsbt),
            _ => None,
        }
    }

    pub fn as_byte(&self) -> u8 {
        match self {
            FileType::Psbt => b'P',
            FileType::Transaction => b'T',
            FileType::Json => b'J',
            FileType::Cbor => b'C',
            FileType::UnicodeText => b'U',
            FileType::KeyTeleportReceiver => b'R',
            FileType::KeyTeleportSender => b'S',
            FileType::KeyTeleportPsbt => b'E',
        }
    }

    pub fn is_known_filetype(byte: u8) -> bool {
        Self::from_byte(byte).is_some()
    }
}

impl Display for FileType {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        match self {
            FileType::Psbt => write!(f, "PSBT"),
            FileType::Transaction => write!(f, "Transaction"),
            FileType::Json => write!(f, "JSON"),
            FileType::Cbor => write!(f, "CBOR"),
            FileType::UnicodeText => write!(f, "Unicode Text"),
            FileType::KeyTeleportReceiver => write!(f, "Key Teleport Receiver"),
            FileType::KeyTeleportSender => write!(f, "Key Teleport Sender"),
            FileType::KeyTeleportPsbt => write!(f, "Key Teleport PSBT"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::FileType;

    #[test]
    fn key_teleport_file_types_roundtrip_bytes() {
        let cases = [
            (b'R', FileType::KeyTeleportReceiver),
            (b'S', FileType::KeyTeleportSender),
            (b'E', FileType::KeyTeleportPsbt),
        ];

        for (byte, file_type) in cases {
            assert_eq!(FileType::from_byte(byte), Some(file_type));
            assert_eq!(file_type.as_byte(), byte);
            assert!(FileType::is_known_filetype(byte));
        }
    }

    #[test]
    fn key_teleport_file_types_have_display_names() {
        assert_eq!(
            FileType::KeyTeleportReceiver.to_string(),
            "Key Teleport Receiver"
        );
        assert_eq!(
            FileType::KeyTeleportSender.to_string(),
            "Key Teleport Sender"
        );
        assert_eq!(FileType::KeyTeleportPsbt.to_string(), "Key Teleport PSBT");
    }
}