Struct AsdfBuilder 

pub struct AsdfBuilder { /* private fields */ }

Builds an ASDF file.

Implementations

impl AsdfBuilder

pub fn new() -> Self

A builder for a new, empty file.

pub fn with_compression(self, compression: Compression) -> Self

Compress every array written from here on.

Blocks already in the builder – those an AsdfFile::edit brought over – keep the compression they had. Use AsdfBuilder::recompress to change those too.

pub fn recompress(self, compression: Compression) -> Self

Compress every block, including those already here.

This is how a whole file’s compression is changed: open it, edit it, recompress, write it back. Each block’s data is already decompressed in the builder, so this only decides how it goes out.

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

The tree being built, for direct manipulation.

pub fn set_str(&mut self, path: &str, value: &str) -> Result<()>

Set a string. It is quoted where needed so it reads back as a string.

pub fn set_i64(&mut self, path: &str, value: i64) -> Result<()>

Set a signed integer.

pub fn set_u64(&mut self, path: &str, value: u64) -> Result<()>

Set an unsigned integer.

pub fn set_f64(&mut self, path: &str, value: f64) -> Result<()>

Set a float.

pub fn set_bool(&mut self, path: &str, value: bool) -> Result<()>

Set a boolean.

pub fn set_null(&mut self, path: &str) -> Result<()>

Set a null.

pub fn set_array<T: ArrayElement>( &mut self, path: &str, values: &[T], ) -> Result<()>

Write a one-dimensional array of any scalar type.

let mut builder = asdf::AsdfBuilder::new();
builder.set_array("counts", &[1u16, 2, 3])?;
builder.set_array("ratios", &[0.5f32, 1.5])?;

pub fn set_array_shaped<T: ArrayElement>( &mut self, path: &str, values: &[T], shape: &[u64], ) -> Result<()>

Write a multi-dimensional array of any scalar type.

The data is taken in C order, and its length must match the shape.

pub fn set_array_u64(&mut self, path: &str, values: &[u64]) -> Result<()>

Write a one-dimensional u64 array. See AsdfBuilder::set_array.

pub fn set_array_i64(&mut self, path: &str, values: &[i64]) -> Result<()>

Write a one-dimensional i64 array. See AsdfBuilder::set_array.

pub fn set_array_f64(&mut self, path: &str, values: &[f64]) -> Result<()>

Write a one-dimensional f64 array. See AsdfBuilder::set_array.

pub fn set_array_f64_shaped( &mut self, path: &str, values: &[f64], shape: &[u64], ) -> Result<()>

Write a multi-dimensional f64 array.

See AsdfBuilder::set_array_shaped.

pub fn add_block(&mut self, data: Vec<u8>) -> usize

Add a raw binary block, returning its index.

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

Assemble the file in memory.

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

Write the file to a path.

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

Write the file to a stream.

Trait Implementations

impl Debug for AsdfBuilder

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

Formats the value using the given formatter.

impl Default for AsdfBuilder

fn default() -> Self

Returns the “default value” for a type.