Struct exr::image::write::WriteImageWithOptions

pub struct WriteImageWithOptions<'img, Layers, OnProgress> {
    image: &'img Image<Layers>,
    on_progress: OnProgress,
    check_compatibility: bool,
    parallel: bool,
}

A temporary writer which can be configured and used to write an image to a file.

Fields

image: &'img Image<Layers>

on_progress: OnProgress

check_compatibility: bool

parallel: bool

Implementations

impl<'img, L, F> WriteImageWithOptions<'img, L, F>

where L: WritableLayers<'img>, F: FnMut(f64),

pub fn infer_meta_data(&self) -> Headers

Generate file meta data for this image. The meta data structure is close to the data in the file.

pub fn non_parallel(self) -> Self

Do not compress multiple pixel blocks on multiple threads at once. Might use less memory and synchronization, but will be slower in most situations.

pub fn skip_compatibility_checks(self) -> Self

Skip some checks that ensure a file can be opened by other exr software. For example, it is no longer checked that no two headers or two attributes have the same name, which might be an expensive check for images with an exorbitant number of headers.

If you write an uncompressed file and need maximum speed, it might save a millisecond to disable the checks, if you know that your file is not invalid any ways. I do not recommend this though, as the file might not be readably by any other exr library after that. You must care for not producing an invalid file yourself.

pub fn on_progress<OnProgress>( self, on_progress: OnProgress, ) -> WriteImageWithOptions<'img, L, OnProgress>

where OnProgress: FnMut(f64),

Specify a function to be called regularly throughout the writing process. Replaces all previously specified progress functions in this reader.

pub fn to_file(self, path: impl AsRef<Path>) -> UnitResult

Write the exr image to a file. Use to_unbuffered instead, if you do not have a file. If an error occurs, attempts to delete the partially written file.

pub fn to_unbuffered(self, unbuffered: impl Write + Seek) -> UnitResult

Buffer the writer and then write the exr image to it. Use to_buffered instead, if your writer is an in-memory buffer. Use to_file instead, if you have a file path. If your writer cannot seek, you can write to an in-memory vector of bytes first, using to_buffered.

pub fn to_buffered(self, write: impl Write + Seek) -> UnitResult

Write the exr image to a writer. Use to_file instead, if you have a file path. Use to_unbuffered instead, if this is not an in-memory writer. If your writer cannot seek, you can write to an in-memory vector of bytes first.

Trait Implementations

impl<'img, Layers: Clone, OnProgress: Clone> Clone for WriteImageWithOptions<'img, Layers, OnProgress>

fn clone(&self) -> WriteImageWithOptions<'img, Layers, OnProgress>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'img, Layers: Debug, OnProgress: Debug> Debug for WriteImageWithOptions<'img, Layers, OnProgress>

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

Formats the value using the given formatter.

impl<'img, Layers: PartialEq, OnProgress: PartialEq> PartialEq for WriteImageWithOptions<'img, Layers, OnProgress>

fn eq(&self, other: &WriteImageWithOptions<'img, Layers, OnProgress>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'img, Layers, OnProgress> StructuralPartialEq for WriteImageWithOptions<'img, Layers, OnProgress>