Struct bc_components::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> ) -> Option<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<T>( uncompressed_data: T, digest: Option<Digest> ) -> Selfwhere T: AsRef<[u8]>,

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>, CompressedError>

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 CBORDecodable for Compressed

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

Creates an instance of this type from CBOR symbolic representation.

fn from_cbor_data(cbor_data: &[u8]) -> Result<Self, Error>where Self: Sized,

Creates an instance of this type from encoded CBOR binary data.

impl CBOREncodable for Compressed

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

fn cbor_data(&self) -> Vec<u8, Global>

Returns the value in CBOR binary representation.

impl CBORTagged for Compressed

const CBOR_TAG: Tag = tags::COMPRESSED

The CBOR tag assocated with this type.

impl CBORTaggedDecodable for Compressed

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

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: &[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: &[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.

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 PartialEq<Compressed> for Compressed

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl URDecodable for Compressed

fn from_ur(ur: &UR) -> Result<Self, Error>where Self: Sized,

fn from_ur_string<T>(ur_string: T) -> Result<Self, Error>where T: Into<String>, Self: Sized,

impl UREncodable for Compressed

fn ur(&self) -> UR

Returns the UR representation of the object.

fn ur_string(&self) -> String

Returns the UR string representation of the object.

impl Eq for Compressed

impl StructuralEq for Compressed

impl StructuralPartialEq for Compressed

impl URCodable for Compressed