Struct libflate::finish::AutoFinish

pub struct AutoFinish<T: Complete> { /* private fields */ }

A wrapper struct that completes the processing of the underlying instance when drops.

This calls Complete:::complete method of T when drops.

Panics

If the invocation of Complete::complete(T) returns an error, AutoFinish::drop() will panic.

Implementations

impl<T: Complete> AutoFinish<T>

pub fn new(inner: T) -> Self

Makes a new AutoFinish instance.

Examples

#[cfg(feature = "no_std")]
use core2::io::Write;
#[cfg(not(feature = "no_std"))]
use std::io::Write;
use libflate::finish::AutoFinish;
use libflate::gzip::Encoder;

let plain = b"Hello World!";
let mut buf = Vec::new();
let mut encoder = AutoFinish::new(Encoder::new(&mut buf).unwrap());
encoder.write_all(plain.as_ref()).unwrap();

pub fn into_inner(self) -> T

Unwraps this AutoFinish instance, returning the underlying instance.

Trait Implementations

impl<T: Debug + Complete> Debug for AutoFinish<T>

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

Formats the value using the given formatter.

impl<T: Complete> Deref for AutoFinish<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Complete> DerefMut for AutoFinish<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Complete> Drop for AutoFinish<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Complete + Write> Write for AutoFinish<T>

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

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

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

Flush 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, fmt: 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.