ZipDataWriter

Struct ZipDataWriter 

Source
pub struct ZipDataWriter<W> { /* private fields */ }
Expand description

A writer for the uncompressed data of a Zip file entry.

This writer will keep track of the data necessary to write the data descriptor (ie: number of bytes written and the CRC32 checksum).

Once all the data has been written, invoke the finish method to receive the DataDescriptorOutput necessary to finalize the entry.

Implementations§

Source§

impl<W> ZipDataWriter<W>

Source

pub fn new(inner: W) -> Self

👎Deprecated since 0.4.0: Use the tuple-based API: ZipFileBuilder::start() returns (writer, builder) which can propagate the CRC32 option

Creates a new ZipDataWriter that writes to an underlying writer.

Source

pub fn get_mut(&mut self) -> &mut W

Gets a mutable reference to the underlying writer.

Source

pub fn finish(self) -> Result<(W, DataDescriptorOutput), Error>
where W: Write,

Consumes self and returns the inner writer and the data descriptor to be passed to a ZipEntryWriter.

The writer is returned to facilitate situations where the underlying compressor needs to be notified that no more data will be written so it can write any sort of necessary epilogue (think zstd).

The DataDescriptorOutput contains the CRC32 checksum and uncompressed size, which is needed by ZipEntryWriter::finish.

Trait Implementations§

Source§

impl<W: Debug> Debug for ZipDataWriter<W>

Source§

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

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

impl<W> Write for ZipDataWriter<W>
where W: Write,

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

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

Like write, except that it writes from a slice of buffers. Read more
Source§

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. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

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

Auto Trait Implementations§

§

impl<W> Freeze for ZipDataWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for ZipDataWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for ZipDataWriter<W>
where W: Send,

§

impl<W> Sync for ZipDataWriter<W>
where W: Sync,

§

impl<W> Unpin for ZipDataWriter<W>
where W: Unpin,

§

impl<W> UnwindSafe for ZipDataWriter<W>
where W: UnwindSafe,

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, 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.