Struct Writer 

pub struct Writer { /* private fields */ }

Assembles an ASDF file.

Implementations

impl Writer

pub fn new() -> Self

A writer with no tree and no blocks.

pub fn from_document(document: Document) -> Self

A writer for an existing tree.

pub fn with_options(self, options: WriteOptions) -> Self

Replace the write options.

pub fn set_document(&mut self, document: Document)

Set the tree to write.

pub fn document(&self) -> Option<&Document>

The tree being written, if any.

pub fn document_mut(&mut self) -> Option<&mut Document>

The tree being written, for mutation.

pub fn add_block(&mut self, block: PendingBlock) -> usize

Queue a block, returning the index it will have in the file.

That index is what an ndarray’s source refers to.

pub fn block_count(&self) -> usize

The number of blocks queued.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Assemble the whole file in memory.

pub fn write_to(&self, sink: &mut impl Write) -> Result<()>

Write the file to a stream.

pub fn write_to_path(&self, path: impl AsRef<Path>) -> Result<()>

Write the file to a path, replacing anything already there.

Trait Implementations

impl Debug for Writer

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

Formats the value using the given formatter.

impl Default for Writer

fn default() -> Self

Returns the “default value” for a type.