Struct webc::v2::write::Writer

pub struct Writer<S> { /* private fields */ }

A serializer for the WEBC format.

Implementations

impl Writer<WritingManifest>

pub fn new(checksum_algorithm: ChecksumAlgorithm) -> Self

Create a new Writer in its initial state.

impl Writer<WritingManifest>

pub fn write_manifest( self, manifest: &Manifest ) -> Result<Writer<WritingAtoms>, WriteError>

Write a Manifest to the manifest section, transitioning from the WritingManifest state to WritingAtoms.

pub fn write_cbor_manifest( self, manifest: &impl Serialize ) -> Result<Writer<WritingAtoms>, WriteError>

Serialize an arbitrary object to CBOR and write it to the manifest section.

Most users should prefer to use Writer::write_manifest(), although this method might be useful in niche circumstances where you have your own, specialized Manifest type.

pub fn write_raw_manifest( self, manifest: impl Into<Bytes> ) -> Writer<WritingAtoms>

Write some bytes to the manifest section.

This assumes the provided bytes encode a valid CBOR object roughly following the Manifest structure.

impl Writer<WritingAtoms>

pub fn write_atoms( self, atoms: BTreeMap<PathSegment, FileEntry<'_>> ) -> Result<Writer<WritingVolumes>, WriteError>

Write some atoms to the atoms section of the file, transitioning from the WritingAtoms state to WritingVolumes.

impl Writer<WritingVolumes>

pub fn write_volume( &mut self, name: &str, volume: Directory<'_> ) -> Result<(), WriteError>

Write a volume to the file.

pub fn with_volume( self, name: &str, volume: Directory<'_> ) -> Result<Self, WriteError>

Add a volume to the file.

pub fn finish( self, signature_algorithm: SignatureAlgorithm ) -> Result<Bytes, WriteError>

Finish writing volumes and get the final WEBC file.

Trait Implementations

impl<S: Debug> Debug for Writer<S>

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

Formats the value using the given formatter.

impl Default for Writer<WritingManifest>

fn default() -> Self

Returns the “default value” for a type.