Struct mupdf::cookie::Cookie

pub struct Cookie { /* fields omitted */ }

Provide two-way communication between application and library. Intended for multi-threaded applications where one thread is rendering pages and another thread wants to read progress feedback or abort a job that takes a long time to finish. The communication is unsynchronized without locking.

Implementations

impl Cookie

pub fn new() -> Result<Self, Error>

pub fn abort(&mut self)

Abort rendering

pub fn progress(&self) -> i32

Communicates rendering progress back to the application. Increments as a page is being rendered.

pub fn max_progress(&self) -> usize

Communicates the known upper bound of rendering back to the application

pub fn errors(&self) -> i32

count of errors during current rendering

pub fn incomplete(&self) -> bool

Initially should be set to 0. Will be set to non-zero if a TRYLATER error is thrown during rendering

pub fn set_incomplete(&mut self, value: bool)

Trait Implementations

impl Debug for Cookie

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

Formats the value using the given formatter.

impl Drop for Cookie

fn drop(&mut self)

Executes the destructor for this type.