Struct hive_asar::Writer

pub struct Writer<F: AsyncRead + Unpin> { /* private fields */ }

Asar archive writer.

Implementations

impl<F: AsyncRead + Unpin> Writer<F>

pub fn new() -> Self

Creates a new, empty archive writer.

pub fn add(&mut self, path: &str, content: F, size: u64)

Add an entry to the archive.

The entry’s parent directories are created recursively if they do not exist.

size should correspond with content. If size is smaller, exactly size bytes will be written. If size is bigger, the Writer::write method will fail. For convenience, you may want to use add_sized.

Panic

The method panics if normalised path contains no filename, or if the path is already occupied by a previously inserted file.

pub fn add_empty_folder(&mut self, path: &str)

Adds an empty folder recursively to the archive.

pub async fn write(self, dest: &mut impl AsyncWrite + Unpin) -> Result<()>

Finishes the archive and writes the content into dest.

impl<F: AsyncRead + AsyncSeek + Unpin> Writer<F>

pub async fn add_sized(&mut self, path: &str, content: F) -> Result<()>

Add an entry to the archive.

Similar to Writer::add, but it uses AsyncSeekExt::seek to determine the size of the content.

For more information see Writer::add.

pub async fn add_sized_with_integrity(
    &mut self,
    path: &str,
    content: F
) -> Result<()>

Available on crate feature integrity only.

Trait Implementations

impl<F: Debug + AsyncRead + Unpin> Debug for Writer<F>

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

Formats the value using the given formatter.

impl<F: AsyncRead + Unpin> Default for Writer<F>

fn default() -> Self

Returns the “default value” for a type.