neo_devpack/
codec.rs

1//! Serialization and deserialization utilities for Neo N3 smart contracts.
2//!
3//! This module provides binary serialization using bincode, which is efficient
4//! for storage and cross-contract communication.
5
6use neo_types::{NeoError, NeoResult};
7use serde::de::DeserializeOwned;
8use serde::Serialize;
9
10/// Serializes a value to bytes using bincode.
11///
12/// # Type Parameters
13/// * `T` - The type to serialize, must implement `Serialize`
14///
15/// # Arguments
16/// * `value` - A reference to the value to serialize
17///
18/// # Returns
19/// * `Ok(Vec<u8>)` - The serialized bytes on success
20/// * `Err(NeoError)` - If serialization fails
21///
22/// # Examples
23///
24/// ```
25/// use neo_devpack::codec::serialize;
26///
27/// let value = 42i32;
28/// let bytes = serialize(&value).unwrap();
29/// ```
30pub fn serialize<T: Serialize>(value: &T) -> NeoResult<Vec<u8>> {
31    bincode::serialize(value)
32        .map_err(|err| NeoError::new(&format!("Failed to serialize value: {err}")))
33}
34
35/// Deserializes bytes to a value using bincode.
36///
37/// # Type Parameters
38/// * `T` - The type to deserialize, must implement `DeserializeOwned`
39///
40/// # Arguments
41/// * `bytes` - The bytes to deserialize from
42///
43/// # Returns
44/// * `Ok(T)` - The deserialized value on success
45/// * `Err(NeoError)` - If deserialization fails (e.g., invalid format)
46///
47/// # Examples
48///
49/// ```
50/// use neo_devpack::codec::{serialize, deserialize};
51///
52/// let value = 42i32;
53/// let bytes = serialize(&value).unwrap();
54/// let restored: i32 = deserialize(&bytes).unwrap();
55/// assert_eq!(value, restored);
56/// ```
57pub fn deserialize<T: DeserializeOwned>(bytes: &[u8]) -> NeoResult<T> {
58    bincode::deserialize(bytes)
59        .map_err(|err| NeoError::new(&format!("Failed to deserialize bytes: {err}")))
60}
neo_devpack/codec.rs

neo_devpack/
codec.rs
