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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
use std::io::{BufWriter, Cursor, Read, Write}; #[cfg(feature="async_tokio")] pub use async_tokio_public::*; #[cfg(feature="serde_support")] pub use serde_public::*; use crate::Element; use crate::error::{TychoResult, TychoStatus}; use crate::read::element::read_element; use crate::write::element::write_element; /// Marshall an element to a byte buffer or writable object. /// /// ### Example /// ``` /// use tycho::{Element::Value, Value::Boolean, marshall}; /// use std::io::BufWriter; /// /// // Create a boolean value. /// let data = Value(Boolean(true)); /// /// // Create a buffer for result. /// let mut buffer = BufWriter::new(Vec::new()); /// /// // Write boolean value to buffer. /// marshall(&mut buffer, data).unwrap(); /// /// assert_eq!(buffer.buffer(), vec![1, 1, 1]); /// ``` pub fn marshall<W: Write, E: Into<Element>>(writer: &mut W, element: E) -> TychoStatus { write_element(writer, &element.into()) } /// Marshall an element into a vec of bytes. /// /// ### Example /// ``` /// use tycho::{Element::Value, Value::Char, marshall_vec}; /// /// // Create a char value. /// let data = Value(Char('@')); /// /// // marshall the value into a vec. /// let bytes = marshall_vec(data).unwrap(); /// /// assert_eq!(bytes, vec![1, 3, 64]); /// ``` pub fn marshall_vec<E: Into<Element>>(element: E) -> TychoResult<Vec<u8>> { let mut buffer = BufWriter::new(Vec::new()); marshall(&mut buffer, element)?; Ok(buffer.into_inner().unwrap()) // todo: issue may occur here not sure. will catch later. } /// Unmarshall an element from a readable object. /// /// ### Example /// ``` /// use std::io::{BufReader, Cursor}; /// use tycho::unmarshall; /// use tycho::Value::Number; /// use tycho::Number::Unsigned8; /// use tycho::Element::Value; /// /// // Create a cursor with example bytes /// let mut bytes = Cursor::new(vec![1, 4, 1, 10]); /// /// // Unmarshall readable object. /// let data = unmarshall(&mut bytes).unwrap(); /// /// assert_eq!(data, Value(Number(Unsigned8(10)))); /// ``` pub fn unmarshall<R: Read>(reader: &mut R) -> TychoResult<Element> { read_element(reader) } /// Unmarshall an element from a vec of bytes. /// /// ### Example /// ``` /// use tycho::unmarshall_vec; /// # use tycho::Number::Unsigned16; /// # use tycho::Element::Value; /// # use tycho::Value::Number; /// /// // Example bytes /// let bytes = vec![1, 4, 2, 1, 164]; /// /// // Unmarshall bytes into vec. /// let data = unmarshall_vec(bytes).unwrap(); /// /// assert_eq!(data, Value(Number(Unsigned16(420)))) /// ``` pub fn unmarshall_vec(data: Vec<u8>) -> TychoResult<Element> { let mut buffer = Cursor::new(data); unmarshall(&mut buffer) } #[cfg(feature="async_tokio")] mod async_tokio_public { use tokio::io::AsyncRead; use crate::Element; use crate::error::TychoResult; use crate::read::async_::element::read_element_async; /// Unmarshall an element from a async readable object. /// /// ### Example /// ``` /// use std::io::{BufReader, Cursor}; /// use tycho::unmarshall_async; /// # use tycho::Number::Unsigned16; /// # use tycho::Element::Value; /// # use tycho::Value::Number; /// # let _ = tokio_test::block_on( async { /// /// // Create a cursor with example bytes /// let mut bytes = Cursor::new(vec![1, 4, 2, 1, 164]); /// /// // Unmarshall cursor /// let data = unmarshall_async(&mut bytes).await.unwrap(); /// /// assert_eq!(data, Value(Number(Unsigned16(420)))); /// # }); /// ``` /// /// ### File Example /// ```no_run /// use std::io::{BufReader, Cursor, Read}; /// use tycho::unmarshall_async; /// # use tycho::Number::Unsigned16; /// # use tycho::Element::Value; /// # use tycho::Value::Number; /// # let _ = tokio_test::block_on( async { /// /// // Create a cursor with example bytes /// let mut bytes = tokio::fs::File::open("number.tycho").await.unwrap(); /// /// // Unmarshall cursor /// let data = unmarshall_async(&mut bytes).await.unwrap(); /// /// assert_eq!(data, Value(Number(Unsigned16(420)))); /// # }); /// ``` /// pub async fn unmarshall_async<R: AsyncRead + Unpin + Send>(reader: &mut R) -> TychoResult<Element> { read_element_async(reader).await } } #[cfg(feature="serde_support")] mod serde_public { use serde::de::DeserializeOwned; use serde::Serialize; use crate::{Element, marshall_vec, unmarshall_vec}; use crate::error::TychoResult; use crate::serde::de::TychoDeserializer; use crate::serde::ser::TychoSerializer; /// Serialize a serde serializable object into an Element. (requires `serde_support`) /// /// ``` /// use serde::Serialize; /// use tycho::{to_element, Element}; /// use tycho::collections::Struct; /// /// // Create a serializable serde structure. /// #[derive(Serialize)] /// pub struct Example { /// foo: String /// } /// /// // Instantiate serializable object. /// let data = Example { foo: "Hi".to_string() }; /// /// // Convert serializable serde structure to Elements. /// let element = to_element(data).unwrap(); /// /// // Create structure manually (for assert_eq) /// let mut map = Struct::new(); /// map.insert("foo", "Hi"); /// /// assert_eq!(element, map.into()) /// ``` pub fn to_element<S: Serialize>(o: S) -> TychoResult<Element> { o.serialize(TychoSerializer) } /// Serialize a serde serializable object into tycho bytes. (requires `serde_support`) /// /// ``` /// use serde::Serialize; /// use tycho::{Element, to_bytes}; /// /// // Create a serializable serde structure. /// #[derive(Serialize)] /// pub struct Example { /// foo: String /// } /// /// // Instantiate serializable object. /// let data = Example { foo: "Hi".to_string() }; /// /// // Convert serializable serde structure to bytes. /// let bytes = to_bytes(data).unwrap(); /// /// assert_eq!(bytes, vec![5, 9, 102, 111, 111, 0, 1, 2, 2, 72, 105]) /// ``` pub fn to_bytes<S: Serialize>(o: S) -> TychoResult<Vec<u8>> { marshall_vec(to_element(o)?) } /// Deserialize an element into a serde deserializable object. (requires `serde_support`) /// /// ``` /// use serde::Deserialize; /// use tycho::{Element, from_element}; /// use tycho::collections::Struct; /// /// // Create a serializable serde structure. /// #[derive(Deserialize, PartialEq, Debug)] /// pub struct Example { /// foo: String /// } /// /// // Instantiate object manually. /// let mut map = Struct::new(); /// map.insert("foo", "Hi"); /// /// // Deserialize map /// let example: Example = from_element(map).unwrap(); /// /// assert_eq!(example, Example { foo: "Hi".to_string() }) /// ``` pub fn from_element<D: DeserializeOwned, E: Into<Element>>(e: E) -> TychoResult<D> { D::deserialize(TychoDeserializer::new(e.into())) } /// Deserialize tycho bytes into a serde deserializable object. (requires `serde_support`) /// /// ``` /// use serde::Deserialize; /// use tycho::from_bytes; /// /// // Create a serializable serde structure. /// #[derive(Deserialize, PartialEq, Debug)] /// pub struct Example { /// foo: String /// } /// /// // Example bytes /// let bytes = vec![5, 9, 102, 111, 111, 0, 1, 2, 2, 72, 105]; /// /// // Deserialize bytes /// let data: Example = from_bytes(&bytes).unwrap(); /// /// assert_eq!(data, Example { foo: "Hi".to_string() }) /// /// ``` pub fn from_bytes<D: DeserializeOwned>(b: &[u8]) -> TychoResult<D> { from_element(unmarshall_vec(b.to_vec())?) } } pub use crate::into::ident::Ident; pub use crate::into::value::ValueType; #[cfg(feature="compression")] pub use crate::into::compression;