Struct FileEntryBuilder 

pub struct FileEntryBuilder { /* private fields */ }

A builder for creating a regular file NormalEntry.

Data written via the Write trait is compressed and encrypted according to the write options given at construction time.

Examples

use libpna::FileEntryBuilder;

let mut builder = FileEntryBuilder::new("file.txt".into())?;
builder.write_all(b"content")?;
let entry = builder.build()?;

Implementations

impl FileEntryBuilder

pub fn new(name: EntryName) -> Result<FileEntryBuilder, Error>

Creates a builder that stores data without compression or encryption.

Errors

Returns an error if initialization fails.

pub fn new_with_options( name: EntryName, option: impl WriteOption, ) -> Result<FileEntryBuilder, Error>

Creates a builder with the given write options.

Errors

Returns an error if initialization fails.

pub fn metadata(&mut self, metadata: Metadata) -> &mut FileEntryBuilder

Sets the metadata of the entry, replacing any previously set metadata.

The raw file size and compressed size recorded in the given metadata are ignored; build() computes them from the written data.

pub fn add_extra_chunk<T>(&mut self, chunk: T) -> &mut FileEntryBuilder

where T: Into<RawChunk>,

Adds extra chunk to the entry.

pub fn max_chunk_size(&mut self, size: NonZero<u32>) -> &mut FileEntryBuilder

Sets the maximum chunk size for data written to this entry.

The default is the maximum allowed chunk size (~4GB).

pub fn store_file_size(&mut self, store: bool) -> &mut FileEntryBuilder

Sets whether to store the raw file size in the entry metadata.

When true (the default), the raw file size is recorded; when false, it is omitted.

pub fn build(self) -> Result<NormalEntry, Error>

Consumes this builder and returns the constructed NormalEntry.

Errors

Returns an error if an I/O error occurs while building entry into buffer.

Trait Implementations

impl Write for FileEntryBuilder

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.