Struct FolderCompressor

Source
pub struct FolderCompressor { /* private fields */ }
Expand description

Compressor struct for a directory.

Implementations§

Source§

impl FolderCompressor

Source

pub fn new<O: AsRef<Path>, D: AsRef<Path>>(source_path: O, dest_path: D) -> Self

Create a new FolderCompressor instance. Just needs source directory path and destination directory path. If you do not set the quality calculation function, it will use the default calculation function which sets the quality only by the file size. Likewise, if you do not set the number of threads, only one thread is used by default.\

§Examples
use image_compressor::FolderCompressor;
use std::path::Path;

let source = Path::new("source");
let dest = Path::new("dest");

let comp = FolderCompressor::new(source, dest);
Source

pub fn set_factor(&mut self, factor: Factor)

Set Factor using to compress images.

Source

pub fn set_delete_source(&mut self, to_delete: bool)

Set whether to delete source files.

Source

pub fn set_sender(&mut self, sender: Sender<String>)

Set Sender for message passing. If you set a sender, the method sends messages whether compressing is complete.

Source

pub fn set_thread_count(&mut self, thread_count: u32)

Setter for the number of threads used to compress images.

§Examples
use image_compressor::FolderCompressor;
use image_compressor::Factor;
use std::path::Path;

let source = Path::new("source");
let dest = Path::new("dest");

let mut comp = FolderCompressor::new(source, dest);
comp.set_thread_count(4);
Source

pub fn compress(self) -> Result<(), Box<dyn Error>>

Folder compress function.

The function will compress all images, using multithreading, in a given source folder and will wait until everything is done. If user set a Sender for FolderCompressor before, the method sends messages whether compressing is complete.

§Warning

Since this function consume its self, the FolderCompressor instance (which is self) is no longer available after calling this function.

use std::path::PathBuf;
use std::sync::mpsc;
use image_compressor::FolderCompressor;

let source = PathBuf::from("source_dir");
let dest = PathBuf::from("dest_dir");
let (tx, tr) = mpsc::channel();

let mut comp = FolderCompressor::new(source, dest);
comp.set_sender(tx);
comp.set_thread_count(4);

match comp.compress(){
    Ok(_) => {},
    Err(e) => println!("Cannot compress the folder: {}", e),
}

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.