Struct Compressed

pub struct Compressed { /* private fields */ }

A compressed binary object.

Implemented using the raw DEFLATE format as described in IETF RFC 1951.

The following obtains the equivalent configuration of the encoder:

deflateInit2(zstream,5,Z_DEFLATED,-15,8,Z_DEFAULT_STRATEGY)

If the payload is too small to compress, the uncompressed payload is placed in the compressedData field and the size of that field will be the same as the uncompressedSize field.

Implementations

impl Compressed

pub fn new( checksum: u32, uncompressed_size: usize, compressed_data: Vec<u8>, digest: Option<Digest>, ) -> Result<Self>

Creates a new Compressed object with the given checksum, uncompressed size, compressed data, and digest.

This is a low-level function that does not check the validity of the compressed data.

Returns None if the compressed data is larger than the uncompressed size.

pub fn from_uncompressed_data( uncompressed_data: impl Into<Vec<u8>>, digest: Option<Digest>, ) -> Self

Creates a new Compressed object from the given uncompressed data and digest.

The uncompressed data is compressed using the DEFLATE format with a compression level of 6.

If the compressed data is smaller than the uncompressed data, the compressed data is stored in the compressed_data field. Otherwise, the uncompressed data is stored in the compressed_data field.

pub fn uncompress(&self) -> Result<Vec<u8>>

Uncompresses the compressed data and returns the uncompressed data.

Returns an error if the compressed data is corrupt or the checksum does not match the uncompressed data.

pub fn compressed_size(&self) -> usize

Returns the size of the compressed data.

pub fn compression_ratio(&self) -> f64

Returns the compression ratio of the compressed data.

pub fn digest_ref_opt(&self) -> Option<&Digest>

Returns a reference to the digest of the compressed data, if it exists.

pub fn has_digest(&self) -> bool

Returns true if the compressed data has a digest.

Trait Implementations

impl AsRef<Compressed> for Compressed

fn as_ref(&self) -> &Compressed

Converts this type into a shared reference of the (usually inferred) input type.

impl CBORTagged for Compressed

fn cbor_tags() -> Vec<Tag>

The CBOR tags assocated with this type. If more than one tag is present, they are considered equivalent for reading, but only the first one is used for writing.

impl CBORTaggedDecodable for Compressed

fn from_untagged_cbor(cbor: CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for Compressed

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for Compressed

fn clone(&self) -> Compressed

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Compressed

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DigestProvider for Compressed

fn digest(&self) -> Cow<'_, Digest>

impl From<Compressed> for CBOR

fn from(value: Compressed) -> Self

Converts to this type from the input type.

impl PartialEq for Compressed

fn eq(&self, other: &Compressed) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<CBOR> for Compressed

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Compressed

impl StructuralPartialEq for Compressed