base_xx 0.9.0

Base XX encoding
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

use crate::{EncodedString, SerialiseError};
use std::sync::Arc;

/// Trait for types that can encode and decode data
pub trait Encoder {
    /// Attempts to encode bytes into a string representation
    ///
    /// # Arguments
    /// * `bytes` - The bytes to encode
    ///
    /// # Returns
    /// The encoded string representation
    ///
    /// # Errors
    /// Returns `SerialiseError` if encoding fails
    fn try_encode(bytes: Arc<Vec<u8>>) -> Result<EncodedString, SerialiseError>;

    /// Attempts to decode a string back into bytes
    ///
    /// # Arguments
    /// * `encoded` - The string to decode
    ///
    /// # Returns
    /// The decoded bytes
    ///
    /// # Errors
    /// Returns `SerialiseError` if decoding fails
    fn try_decode(encoded: &EncodedString) -> Result<Arc<Vec<u8>>, SerialiseError>;
}