Struct comprexor::Compressor
source · pub struct Compressor<'a> { /* private fields */ }
Implementations§
source§impl<'a> Compressor<'a>
impl<'a> Compressor<'a>
sourcepub fn new(input: &'a str, output: &'a str) -> 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();
sourcepub fn compress<T>(&self, level: T) -> Result<ArchiveInfo, Error>where
T: AsRef<CompressionLevel>,
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§
source§impl<'a> Clone for Compressor<'a>
impl<'a> Clone for Compressor<'a>
source§fn clone(&self) -> Compressor<'a>
fn clone(&self) -> Compressor<'a>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<'a> Debug for Compressor<'a>
impl<'a> Debug for Compressor<'a>
source§impl<'a> Hash for Compressor<'a>
impl<'a> Hash for Compressor<'a>
source§impl<'a> PartialEq<Compressor<'a>> for Compressor<'a>
impl<'a> PartialEq<Compressor<'a>> for Compressor<'a>
source§fn eq(&self, other: &Compressor<'a>) -> bool
fn eq(&self, other: &Compressor<'a>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<'a> PartialOrd<Compressor<'a>> for Compressor<'a>
impl<'a> PartialOrd<Compressor<'a>> for Compressor<'a>
source§fn partial_cmp(&self, other: &Compressor<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &Compressor<'a>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moreimpl<'a> StructuralPartialEq for Compressor<'a>
Auto Trait Implementations§
impl<'a> RefUnwindSafe for Compressor<'a>
impl<'a> Send for Compressor<'a>
impl<'a> Sync for Compressor<'a>
impl<'a> Unpin for Compressor<'a>
impl<'a> UnwindSafe for Compressor<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more