data-anchor-utils 0.4.6

Data Anchor utilities library
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

#[cfg(feature = "compression")]
pub mod compression;
pub mod encoding;

#[cfg(feature = "compression")]
mod wrapper {
    /// Utility functions for encoding and compression in Data Anchor.
    #[derive(Debug, thiserror::Error)]
    pub enum DataAnchorUtilsError {
        #[error(transparent)]
        CompressionError(#[from] crate::compression::DataAnchorCompressionError),
        #[error(transparent)]
        EncodingError(#[from] crate::encoding::DataAnchorEncodingError),
    }

    /// Result type for Data Anchor utilities, encapsulating potential errors.
    pub type DataAnchorUtilsResult<T = ()> = Result<T, DataAnchorUtilsError>;

    /// Utility functions for encoding and compression in Data Anchor.
    pub fn encode_and_compress<T>(
        encoding: &EncodingType,
        compression: &CompressionType,
        data: &T,
    ) -> DataAnchorUtilsResult<Vec<u8>>
    where
        T: crate::encoding::Encodable,
    {
        let encoded_data = encoding.encode(data)?;
        Ok(compression.compress(&encoded_data)?)
    }

    /// Utility function to decompress and decode data in Data Anchor.
    pub fn decompress_and_decode<T>(data: &[u8]) -> DataAnchorUtilsResult<T>
    where
        T: crate::encoding::Decodable,
    {
        let decompressed_data = CompressionType::default().decompress(data)?;
        Ok(EncodingType::default().decode(&decompressed_data)?)
    }

    #[cfg(feature = "async")]
    mod _async {
        use super::DataAnchorUtilsResult;
        use crate::{
            compression::{CompressionType, DataAnchorCompressionAsync},
            encoding::{DataAnchorEncoding, EncodingType},
        };

        /// Utility functions for encoding and compression in Data Anchor.
        pub async fn encode_and_compress_async<T>(
            encoding: &EncodingType,
            compression: &CompressionType,
            data: &T,
        ) -> DataAnchorUtilsResult<Vec<u8>>
        where
            T: crate::encoding::Encodable,
        {
            let encoded_data = encoding.encode(data)?;
            Ok(compression.compress_async(&encoded_data).await?)
        }

        /// Utility function to decompress and decode data in Data Anchor.
        pub async fn decompress_and_decode_async<T>(data: &[u8]) -> DataAnchorUtilsResult<T>
        where
            T: crate::encoding::Decodable,
        {
            let decompressed_data = CompressionType::default().decompress_async(data).await?;
            Ok(EncodingType::default().decode(&decompressed_data)?)
        }
    }

    #[cfg(feature = "async")]
    pub use _async::*;

    use crate::{
        compression::{CompressionType, DataAnchorCompression},
        encoding::{DataAnchorEncoding, EncodingType},
    };
}

#[cfg(feature = "compression")]
pub use wrapper::*;