Struct TarballBuilder

pub struct TarballBuilder<'c> {
    inner: Builder<CompressionEncoder<'c>>,
}

Wraps a Builder that writes to a CompressionEncoder.

As CompressionEncoder has an uncompressed variant, this can be used to create either compressed tarballs .tar.* or uncompressed tar archives .tar.

Fields

inner: Builder<CompressionEncoder<'c>>

Implementations

impl<'c> TarballBuilder<'c>

pub fn new(file: File, settings: &CompressionSettings) -> Result<Self, Error>

Creates a new TarballBuilder that writes to the given File with the given CompressionSettings.

Errors

Returns an error if CompressionEncoder initialization fails.

pub fn inner_mut(&mut self) -> &mut Builder<CompressionEncoder<'c>>

Returns a mutable reference to the inner Builder.

This can be used to set options to the builder or append files to the tarball.

Examples

builder.inner_mut().follow_symlinks(false);

pub fn finish(self) -> Result<(), Error>

Finishes writing the tarball.

Delegates to CompressionEncoder::finish of the inner Builder.

Errors

Returns an error if the CompressionEncoder fails to finish the compression stream.

Trait Implementations

impl Debug for TarballBuilder<'_>

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

Formats the value using the given formatter.

impl<'c> From<CompressionEncoder<'c>> for TarballBuilder<'c>

fn from(encoder: CompressionEncoder<'c>) -> Self

Creates a TarballBuilder from a CompressionEncoder.