Struct comprexor::Compressor

pub struct Compressor<'a> { /* private fields */ }

Implementations

impl<'a> Compressor<'a>

pub fn new(input: &'a str, output: &'a str) -> Compressor<'a>

Creates a new compressor with the given input and output

Example

use comprexor::{CompressionLevel, Compressor};

let compressor = Compressor::new("./folder-or-file-to-compress", "./compacted-archive.tar.gz");
compressor.compress(CompressionLevel::Maximum).unwrap();

pub fn compress<T>(&self, level: T) -> Result<ArchiveInfo, Error>where T: AsRef<CompressionLevel>,

Compress the input file or folder to the output location

You can choose the compression level with the CompressionLevel enum

The compression level can be:

• CompressionLevel::None
• CompressionLevel::Fast
• CompressionLevel::Default
• CompressionLevel::Maximum
• CompressionLevel::Custom (you can specify the compression level between 0 and 9)

Example

use comprexor::{CompressionLevel, Compressor};

let compressor = Compressor::new("./folder-or-file-to-compress", "./compacted-archive.tar.gz");
compressor.compress(CompressionLevel::Maximum).unwrap();

Errors

This function will return an error if the input file is not a valid gzip file or something goes wrong while compressing

Trait Implementations

impl<'a> Clone for Compressor<'a>

fn clone(&self) -> Compressor<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Compressor<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Compressor<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<Compressor<'a>> for Compressor<'a>

fn eq(&self, other: &Compressor<'a>) -> 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<'a> PartialOrd<Compressor<'a>> for Compressor<'a>

fn partial_cmp(&self, other: &Compressor<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralPartialEq for Compressor<'a>