hpl_toolkit/utils/
short_vec.rs

1use std::ops::{Index, IndexMut};
2
3use super::Inner;
4use anchor_lang::prelude::*;
5
6#[cfg(feature = "compression")]
7use crate::compression::*;
8
9#[cfg(feature = "schema")]
10use crate::schema::*;
11
12#[cfg_attr(feature = "debug", derive(Debug))]
13#[derive(Clone, Eq, PartialEq)]
14pub struct ShortVec<T: Inner>(Vec<T>);
15
16impl<T: Inner> ShortVec<T> {
17    pub fn new() -> Self {
18        Self(Vec::new())
19    }
20
21    pub fn new_from_vec(vec: Vec<T>) -> std::io::Result<Self> {
22        if vec.len() > 255 {
23            return Err(std::io::Error::new(
24                std::io::ErrorKind::InvalidInput,
25                "Short string length shall not exceed 255",
26            ));
27        }
28        Ok(Self(vec))
29    }
30
31    pub fn new_from_vec_unchecked(vec: Vec<T>) -> Self {
32        Self::new_from_vec(vec).expect("Short Vec length shall not exceed 255")
33    }
34
35    pub unsafe fn new_from_vec_unsafe(vec: Vec<T>) -> Self {
36        Self::new_from_vec_unchecked(vec)
37    }
38
39    pub fn inner(&self) -> &Vec<T> {
40        &self.0
41    }
42
43    pub fn inner_mut(&mut self) -> &mut Vec<T> {
44        &mut self.0
45    }
46
47    pub fn as_vec(&self) -> Vec<T> {
48        self.0.clone()
49    }
50
51    pub fn as_slice(&self) -> &[T] {
52        self.0.as_slice()
53    }
54
55    pub fn into_vec(self) -> Vec<T> {
56        self.0
57    }
58
59    pub fn push(&mut self, item: T) {
60        self.0.push(item)
61    }
62
63    pub fn pop(&mut self) -> Option<T> {
64        self.0.pop()
65    }
66
67    pub fn remove(&mut self, index: usize) -> T {
68        self.0.remove(index)
69    }
70
71    pub fn len(&self) -> usize {
72        self.0.len()
73    }
74}
75
76impl<T: Inner + PartialEq> ShortVec<T> {
77    pub fn contains(&self, item: &T) -> bool {
78        self.0.contains(item)
79    }
80}
81
82impl<T: Inner> Into<Vec<T>> for ShortVec<T> {
83    fn into(self) -> Vec<T> {
84        self.0
85    }
86}
87
88impl<T: Inner> From<Vec<T>> for ShortVec<T> {
89    fn from(value: Vec<T>) -> Self {
90        Self::new_from_vec_unchecked(value)
91    }
92}
93
94impl<T: Inner> From<&Vec<T>> for ShortVec<T> {
95    fn from(value: &Vec<T>) -> Self {
96        Self::new_from_vec_unchecked(value.to_vec())
97    }
98}
99
100impl<T: Inner + PartialEq> PartialEq<Vec<T>> for ShortVec<T> {
101    fn eq(&self, other: &Vec<T>) -> bool {
102        self.0 == *other
103    }
104}
105
106impl<T: Inner> AnchorSerialize for ShortVec<T> {
107    fn serialize<W: std::io::Write>(&self, writer: &mut W) -> std::io::Result<()> {
108        let length = self.0.len() as u8;
109        length.serialize(writer)?;
110        self.0.iter().try_for_each(|item| item.serialize(writer))?;
111        Ok(())
112    }
113}
114
115impl<T: Inner> AnchorDeserialize for ShortVec<T> {
116    fn deserialize_reader<R: std::io::Read>(reader: &mut R) -> std::io::Result<Self> {
117        let mut buf: [u8; 1] = [0; 1];
118        let limit = reader.read(&mut buf)?;
119        if limit != 1 {
120            #[cfg(feature = "log")]
121            crate::logger::debug!("limit: {}, Buf: {:?}", limit, buf);
122            return Err(std::io::Error::new(
123                std::io::ErrorKind::InvalidInput,
124                "Unexpected length of input",
125            ));
126        }
127
128        let mut vec = Vec::<T>::new();
129
130        for _ in 0..buf[0] {
131            vec.push(T::deserialize_reader(reader)?);
132        }
133
134        Ok(Self(vec))
135    }
136}
137
138#[cfg(feature = "idl-build")]
139impl<T: Inner> anchor_lang::IdlBuild for ShortVec<T> {
140    /// Returns the full module path of the type.
141    fn get_full_path() -> String {
142        format!("{0}::{1}", "hpl_toolkit::utils::short_vec", "ShortVec",)
143    }
144}
145
146#[cfg(feature = "compression")]
147impl<T: Inner + ToNode> ToNode for ShortVec<T> {
148    fn to_node(&self) -> [u8; 32] {
149        self.0.to_node()
150    }
151}
152
153#[cfg(feature = "schema")]
154impl<T: Inner + ToNode + ToSchema> ToSchema for ShortVec<T> {
155    fn schema() -> Schema {
156        Vec::<T>::schema()
157    }
158
159    fn schema_value(&self) -> SchemaValue {
160        self.0.schema_value()
161    }
162}
163
164pub struct ShortVecIter<T: Inner>(std::vec::IntoIter<T>);
165
166impl<T: Inner> Iterator for ShortVecIter<T> {
167    type Item = T;
168
169    fn next(&mut self) -> Option<Self::Item> {
170        self.0.next()
171    }
172}
173
174impl<T: Inner> FromIterator<T> for ShortVec<T> {
175    fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
176        let mut short_vec: ShortVec<T> = ShortVec::new_from_vec_unchecked(vec![]);
177        for t in iter {
178            short_vec.0.push(t);
179        }
180        short_vec
181    }
182}
183
184impl<T: Inner> IntoIterator for ShortVec<T> {
185    type Item = T;
186    type IntoIter = ShortVecIter<T>;
187
188    fn into_iter(self) -> Self::IntoIter {
189        ShortVecIter(self.0.into_iter())
190    }
191}
192
193impl<T: Inner> Index<usize> for ShortVec<T> {
194    type Output = T;
195    fn index(&self, i: usize) -> &T {
196        &self.0[i]
197    }
198}
199
200impl<T: Inner> IndexMut<usize> for ShortVec<T> {
201    fn index_mut(&mut self, i: usize) -> &mut T {
202        &mut self.0[i]
203    }
204}