kaigan 0.1.4

Rust companion for Kinobi
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
98
99
100
101
102
103

use borsh::{BorshDeserialize, BorshSerialize};
use std::fmt::Debug;
use std::io::Write;
use std::ops::Deref;
use std::str::FromStr;

/// A wrapped `str` type.
///
/// This is useful for deserializing a string value that does not have
/// a length prefix.
#[derive(Clone, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct RemainderStr(String);

impl RemainderStr {
    pub fn from(value: String) -> Self {
        value.into()
    }
}

impl FromStr for RemainderStr {
    type Err = std::convert::Infallible;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Self(s.to_string()))
    }
}

impl Deref for RemainderStr {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl From<&str> for RemainderStr {
    fn from(value: &str) -> Self {
        Self(value.to_string())
    }
}

impl From<String> for RemainderStr {
    fn from(value: String) -> Self {
        Self(value)
    }
}

impl Debug for RemainderStr {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_fmt(format_args!("{:?}", self.0))
    }
}

impl BorshDeserialize for RemainderStr {
    fn deserialize(buffer: &mut &[u8]) -> borsh::maybestd::io::Result<Self> {
        let value = String::from_utf8_lossy(buffer).to_string();
        *buffer = &buffer[value.len()..];
        Ok(Self(value))
    }
}

impl BorshSerialize for RemainderStr {
    fn serialize<W: Write>(&self, writer: &mut W) -> borsh::maybestd::io::Result<()> {
        // serialize the bytes of the string without adding a prefix
        for c in self.0.as_bytes() {
            c.serialize(writer)?;
        }
        Ok(())
    }
}

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

    #[test]
    fn deserialize_data() {
        // slices of bytes
        let mut data = [0u8; 3];
        data[0] = b's';
        data[1] = b't';
        data[2] = b'r';

        let str = RemainderStr::try_from_slice(&data).unwrap();

        assert_eq!(str.len(), 3);
        assert_eq!(str.deref(), "str");
    }

    #[test]
    fn serialize_data() {
        let source: RemainderStr = "this is a longer str".into();

        let mut data = [0u8; "this is a longer str".len()];
        source.serialize(&mut data.as_mut_slice()).unwrap();

        let restored = RemainderStr::try_from_slice(&data).unwrap();

        assert_eq!(restored.len(), source.len());
        assert_eq!(restored, source);
    }
}