Skip to main content

FileData

Enum FileData 

Source
pub enum FileData {
    Bytes(Vec<u8>),
    Path(PathBuf),
}
Expand description

File content — either in-memory bytes or a path on disk.

Small outputs (images, CSVs) use Bytes. Files on disk (CLI argument files, file-collect results, shell-run file-mode outputs) use Path to avoid reading multi-GB files into memory. A Path may be the user’s own file: write it out with copy_to(); write_to() moves it.

Variants§

§

Bytes(Vec<u8>)

In-memory file content (images, CSVs, small outputs).

§

Path(PathBuf)

Reference to a file on disk (CLI inputs, collected files, shell outputs). The file is NOT read into memory until into_bytes() is called.

Implementations§

Source§

impl FileData

Source

pub fn write_to(&self, dest: &Path) -> Result<(), Error>

Move or write file content to a destination path.

Path variant attempts rename() first (O(1) on same filesystem), falling back to copy+delete for cross-device moves. Bytes variant writes data directly.

Source

pub fn len(&self) -> Result<u64, Error>

Byte length without loading into memory. Bytes returns the vec length. Path reads file metadata.

Source

pub fn is_empty(&self) -> Result<bool, Error>

Whether the file data is empty (zero bytes).

Source

pub fn copy_to(&self, dest: &Path) -> Result<(), Error>

Copy file content to a destination path, preserving the source.

Bytes writes data directly. Path copies the file on disk. Unlike write_to(), the source file is never removed.

Source

pub fn into_bytes(self) -> Result<Vec<u8>, Error>

Load file content into memory. Avoid for large files. Bytes is a no-op move. Path reads the file from disk.

Source

pub fn to_bytes(&self) -> Result<Cow<'_, [u8]>, Error>

Read file content without consuming it: borrowed for Bytes, read from disk for Path. For processors that hold files by reference (batch input) and need the bytes of some of them.

Trait Implementations§

Source§

impl Clone for FileData

Source§

fn clone(&self) -> Self

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 FileData

Source§

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

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

impl PartialEq for FileData

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FileData

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> 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, 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.