Skip to main content

Split

Struct Split 

Source
pub struct Split {
    pub in_file: Option<PathBuf>,
    pub out_dir: Option<PathBuf>,
    pub chunk_size: usize,
    pub buffer_capacity: usize,
}
Expand description

Process to split file from a path to a directory.

§Example

use std::path::PathBuf;

use filerune_fusion::split::{Split, SplitResult};

let result: SplitResult = Split::new()
    .in_file(PathBuf::from("path").join("to").join("file"))
    .out_dir(PathBuf::from("path").join("to").join("dir"))
    .run()
    .unwrap();

Fields§

§in_file: Option<PathBuf>§out_dir: Option<PathBuf>§chunk_size: usize§buffer_capacity: usize

Implementations§

Source§

impl Split

Source

pub fn new() -> Self

Create a new split process.

Source

pub fn from<P: Into<Split>>(process: P) -> Self

Create a new split process from an existing one.

Source

pub fn in_file<InFile: AsRef<Path>>(self, path: InFile) -> Self

Set the input file.

Source

pub fn out_dir<OutDir: AsRef<Path>>(self, path: OutDir) -> Self

Set the output directory.

Source

pub fn chunk_size(self, size: usize) -> Self

Set the maximum size of each chunk.

By default, the chunk size follows the CHUNK_SIZE_DEFAULT.

Source

pub fn buffer_capacity(self, capacity: usize) -> Self

Set the size of the buffer capacity.

By default, it is BUFFER_CAPACITY_DEFAULT.

Source

pub fn run(&self) -> Result<SplitResult, SplitError>

Run the split process.

Trait Implementations§

Source§

impl Clone for Split

Source§

fn clone(&self) -> Split

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Split

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Split

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl SplitAsyncExt for Split

Source§

async fn run_async(&self) -> Result<SplitResult, SplitError>

Run the split process asynchronously.
Source§

impl SplitAsyncExt for Split

Source§

async fn run_async(&self) -> Result<SplitResult, SplitError>

Run the split process asynchronously.
Source§

impl SplitAsyncExt for Split

Source§

async fn run_async(&self) -> Result<SplitResult, SplitError>

Run the split process asynchronously.

Auto Trait Implementations§

§

impl Freeze for Split

§

impl RefUnwindSafe for Split

§

impl Send for Split

§

impl Sync for Split

§

impl Unpin for Split

§

impl UnsafeUnpin for Split

§

impl UnwindSafe for Split

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more