Struct WriteOptions

pub struct WriteOptions { /* private fields */ }

Flags to alter the behavior of the writer

Example

let opts = WriteOptions::new("My Awesome Astronomy Program")
    .checksum_algorithm(Some(ChecksumAlgorithm::Sha3_512))
    .compression_algorithm(Some((CompressionAlgorithm::Zlib, CompressionLevel::AUTO)));

Implementations

impl WriteOptions

pub fn new(app_name: impl Into<String>) -> Self

Creates a new WriteOptions with the given app name, and all other options set to their default values

pub fn app_name(&mut self, name: String) -> &mut Self

Name of the application using this library

pub fn export_fits_keywords(&mut self, export: bool) -> &mut Self

Write FITS headers as FITSKeyword elements in the XML header

pub fn checksum_algorithm( &mut self, alg: Option<ChecksumAlgorithm>, ) -> &mut Self

Algorithm used for XISF data block checksum calculations

pub fn compression_algorithm( &mut self, alg: Option<(CompressionAlgorithm, CompressionLevel)>, ) -> &mut Self

Algorithm used to compress XISF data blocks

pub fn fp_lower_bound(&mut self, low: f64) -> &mut Self

Lower bound for floating-point pixel samples

pub fn fp_upper_bound(&mut self, high: f64) -> &mut Self

Upper bound for floating-point pixel samples

pub fn block_alignment_size(&mut self, size: u16) -> &mut Self

Data blocks are allocated with block sizes of integer multiples of this value, in bytes

pub fn max_inline_block_size(&mut self, size: u16) -> &mut Self

Max size (in bytes) that an XISF data block can be before it can no longer be inlined/embedded. Recommended value: 3/4 the size of block_alignment_size (or a multiple of it), since base64 takes 4 chars to encode 3 bytes. That is, a maximum-size inline data block can be base64-encoded into a buffer the same size as the block alignment size

Trait Implementations

impl Clone for WriteOptions

fn clone(&self) -> WriteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOptions

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

Formats the value using the given formatter.