Struct FilePayload 

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

A format-neutral, uncompressed file payload supplied to an ArchiveBuilder implementation.

Implementations

impl<'a> FilePayload<'a>

pub fn new<R>(size: u64, source: R) -> FilePayload<'a>

where R: AsyncRead + 'a,

Creates a payload with a declared logical size and AsyncRead source.

The builder reads exactly size bytes from source. Additional bytes remain unread, while a source that ends early causes the addition to fail.

pub fn size(&self) -> u64

Returns the logical, uncompressed source size in bytes.

This is the total number of bytes yielded by Self::next_chunk, not necessarily the size ultimately stored by the archive format.

pub async fn next_chunk<E>(&mut self) -> Result<Option<&[u8]>, BuildError<E>>

Returns the next chunk of logical, uncompressed source bytes.

Once this method has been called, the payload cannot be passed to Builder::add_file.

impl FilePayload<'static>

pub async fn from_path<P>(path: P) -> Result<FilePayload<'static>, Error>

where P: AsRef<Path>,

Opens path and creates a payload from the complete regular file.

pub async fn from_file(file: File) -> Result<FilePayload<'static>, Error>

Creates a payload from the unread contents of a tokio::fs::File.

The declared size is the file length minus its current stream position. This constructor rejects filesystem objects that are not regular files.

Trait Implementations

impl<'a> From<&'a [u8]> for FilePayload<'a>

fn from(bytes: &'a [u8]) -> FilePayload<'a>

Converts to this type from the input type.