Struct singlefile_formats::Compressed

pub struct Compressed<C, F> {
    pub format: F,
    pub compression: C,
    pub level: u32,
}

Combines a FileFormat and a CompressionFormat, making the contents emitted by the format compressed before writing to disk, and decompressed before parsing.

Fields

format: F

The FileFormat to be used.

compression: C

The CompressionFormat to be used.

level: u32

The level of compression to use. This value may have different meanings for different compression formats.

Implementations

impl<C, F> Compressed<C, F>

pub const fn with_level(format: F, compression: C, level: u32) -> Self

Create a new Compressed, given a compression level.

impl<C, F> Compressed<C, F>

where C: CompressionFormatLevels,

pub const fn new(format: F, compression: C) -> Self

Creates a new Compressed with the default compression level.

pub const fn new_fast_compression(format: F, compression: C) -> Self

Creates a new Compressed with the ‘fast’ compression level.

pub const fn new_best_compression(format: F, compression: C) -> Self

Creates a new Compressed with the ‘best’ compression level.

Trait Implementations

impl<C: Clone, F: Clone> Clone for Compressed<C, F>

fn clone(&self) -> Compressed<C, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, F: Debug> Debug for Compressed<C, F>

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

Formats the value using the given formatter.

impl<C, F> Default for Compressed<C, F>

where C: Default + CompressionFormatLevels, F: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T, C, F> FileFormat<T> for Compressed<C, F>

where C: CompressionFormat, F: FileFormat<T>,

type FormatError = <F as FileFormat<T>>::FormatError

The type of error to return from to_writer and from_reader.

fn from_reader<R: Read>(&self, reader: R) -> Result<T, Self::FormatError>

Deserialize a value from a Read stream.

fn to_writer<W: Write>( &self, writer: W, value: &T ) -> Result<(), Self::FormatError>

Serialize a value into a Write stream.

fn from_reader_buffered<R>(&self, reader: R) -> Result<T, Self::FormatError>

where R: Read,

Identical to FileFormat::from_reader, however the provided reader is buffered with BufReader.

fn from_buffer(&self, buf: &[u8]) -> Result<T, Self::FormatError>

Deserialize a value from a byte vec.

fn to_writer_buffered<W>( &self, writer: W, value: &T ) -> Result<(), Self::FormatError>

where W: Write,

Identical to FileFormat::to_writer, however the provided writer is buffered with BufWriter.

fn to_buffer(&self, value: &T) -> Result<Vec<u8>, Self::FormatError>

Serialize a value into a byte vec.

impl<C: PartialEq, F: PartialEq> PartialEq for Compressed<C, F>

fn eq(&self, other: &Compressed<C, F>) -> 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<C: Copy, F: Copy> Copy for Compressed<C, F>

impl<C: Eq, F: Eq> Eq for Compressed<C, F>

impl<C, F> StructuralEq for Compressed<C, F>

impl<C, F> StructuralPartialEq for Compressed<C, F>