Struct Update 

pub struct Update { /* private fields */ }

Changes for MdzArchive::update. Build one with the methods below.

let archive = mdzip_core::MdzArchive::open(data)?;
let changes = mdzip_core::Update::new()
    .write("images/logo.png", b"\x89PNG")
    .set("title", "New title");
let updated = mdzip_core::MdzArchive::open(archive.update(&changes)?)?;
assert_eq!(updated.title(), Some("New title"));

Implementations

impl Update

pub fn new() -> Self

No changes: saving keeps everything and refreshes modified.

pub fn write(self, path: impl Into<String>, content: impl AsRef<[u8]>) -> Self

Add or replace a file.

pub fn remove(self, path: impl Into<String>) -> Self

Remove a file, directory entry or symbolic link.

pub fn set(self, field: impl Into<String>, value: impl Into<Value>) -> Self

Set a top-level manifest field.

pub fn unset(self, field: impl Into<String>) -> Self

Delete a top-level manifest field.

pub fn entry_point(self, path: impl Into<String>) -> Self

Change the entry point. Without this, an update that would change which file the entry point resolves to fails.

pub fn when(self, when: SystemTime) -> Self

Timestamp for modified and written entries. Defaults to now.

pub fn keep_line_endings(self) -> Self

Keep CRLF in written Markdown files.

pub fn drop_special_files(self) -> Self

Drop symbolic link entries (when the user agrees, Section 14.1).

Trait Implementations

impl Clone for Update

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Update

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

Formats the value using the given formatter.

impl Default for Update

fn default() -> Self

Returns the “default value” for a type.