Struct Project 

pub struct Project {
    pub book: Book,
    pub assets: Vec<Asset>,
    pub meta: Meta,
}

A book with its images and file metadata: what a .kernsetzer holds.

Fields

book: Book

assets: Vec<Asset>

In file order; ids are unique and valid (Asset::is_valid_id).

meta: Meta

Implementations

impl Project

pub fn new(book: Book, assets: Vec<Asset>) -> Self

pub fn asset(&self, id: &str) -> Option<&Asset>

pub fn read<R: Read + Seek>(reader: R) -> Result<Self, ProjectError>

Read a .kernsetzer archive. book.json is migrated to the current format. A missing or unreadable meta.json is not an error (the book is what matters); entries under assets/ whose names are not valid ids (.DS_Store, sub-folders) and unknown entries are skipped. Asset metadata is derived from the bytes.

pub fn write<W: Write + Seek>(&self, writer: W) -> Result<W, ProjectError>

Write the archive as is (meta.modified unchanged).

pub fn open(path: &Path) -> Result<Self, ProjectError>

pub fn save(&mut self, path: &Path) -> Result<(), ProjectError>

Save to path (atomically), set meta.modified, and remove the autosave sidecar: after a clean save there is nothing to recover.

pub fn autosave(&self, path: &Path) -> Result<(), ProjectError>

Write the autosave sidecar for the project at path (autosave_path); the project file itself is not touched.

Trait Implementations

impl Clone for Project

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 Project

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

Formats the value using the given formatter.

impl PartialEq for Project

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Project