Struct PdfiumRenderFlags 

pub struct PdfiumRenderFlags(/* private fields */);

Flags controlling the PDFium rendering behavior.

These flags can be combined using bitwise OR operations to customize the rendering process for different use cases such as printing, debugging, or optimizing for specific display types.

Implementations

impl PdfiumRenderFlags

pub const ANNOT: Self

ANNOT: Render annotations (comments, highlights, form fields, etc.) Enable this to include interactive elements in the rendered output.

pub const LCD_TEXT: Self

LCD_TEXT: Use LCD text rendering for better clarity on LCD screens. This uses subpixel rendering to improve text sharpness on LCD displays.

pub const NO_NATIVETEXT: Self

NO_NATIVETEXT: Disable native text rendering optimizations. Forces PDFium to render text as paths instead of using system fonts.

pub const GRAYSCALE: Self

GRAYSCALE: Render in grayscale mode. Converts all colors to grayscale values, useful for black & white printing.

pub const REVERSE_BYTE_ORDER: Self

REVERSE_BYTE_ORDER: Reverse byte order for pixel data. Changes from BGRA to RGBA or vice versa, depending on platform requirements.

pub const CONVERT_FILL_TO_STROKE: Self

CONVERT_FILL_TO_STROKE: Convert filled paths to stroked paths. Useful for creating outlines or wireframe representations.

pub const DEBUG_INFO: Self

DEBUG_INFO: Include debug information in the rendering process. May affect performance but provides additional diagnostic information.

pub const NO_CATCH: Self

NO_CATCH: Don’t catch exceptions during rendering. Allows exceptions to propagate for debugging purposes - use with caution.

pub const RENDER_LIMITEDIMAGECACHE: Self

RENDER_LIMITEDIMAGECACHE: Limit image cache size during rendering. Reduces memory usage at the cost of potential performance impact.

pub const RENDER_FORCEHALFTONE: Self

RENDER_FORCEHALFTONE: Force halftone rendering for images. Applies halftone patterns, typically used for print output optimization.

pub const PRINTING: Self

PRINTING: Optimize rendering for printing output. Applies print-specific optimizations and color handling.

pub const RENDER_NO_SMOOTHTEXT: Self

RENDER_NO_SMOOTHTEXT: Disable anti-aliasing for text rendering. Results in pixelated but potentially faster text rendering.

pub const RENDER_NO_SMOOTHIMAGE: Self

RENDER_NO_SMOOTHIMAGE: Disable anti-aliasing for image rendering. Images will appear pixelated but render faster with less memory usage.

pub const RENDER_NO_SMOOTHPATH: Self

RENDER_NO_SMOOTHPATH: Disable anti-aliasing for vector path rendering. Paths and shapes will have jagged edges but render more quickly.

impl PdfiumRenderFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> i32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: i32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: i32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: i32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl PdfiumRenderFlags

pub const fn iter(&self) -> Iter<PdfiumRenderFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<PdfiumRenderFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl PdfiumRenderFlags

pub fn fast_rendering() -> Self

Returns flags optimized for fast rendering with minimal quality. Disables anti-aliasing and other quality features for maximum speed.

pub fn debug() -> Self

Returns flags for debugging purposes. Includes debug information and disables exception catching.

Trait Implementations

impl Binary for PdfiumRenderFlags

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

Formats the value using the given formatter.

impl BitAnd for PdfiumRenderFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = PdfiumRenderFlags

The resulting type after applying the & operator.

impl BitAndAssign for PdfiumRenderFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for PdfiumRenderFlags

fn bitor(self, other: PdfiumRenderFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = PdfiumRenderFlags

The resulting type after applying the | operator.

impl BitOrAssign for PdfiumRenderFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for PdfiumRenderFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = PdfiumRenderFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for PdfiumRenderFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for PdfiumRenderFlags

fn clone(&self) -> PdfiumRenderFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfiumRenderFlags

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

Formats the value using the given formatter.

impl Extend<PdfiumRenderFlags> for PdfiumRenderFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for PdfiumRenderFlags

const FLAGS: &'static [Flag<PdfiumRenderFlags>]

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> i32

Get the underlying bits value.

fn from_bits_retain(bits: i32) -> PdfiumRenderFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<PdfiumRenderFlags> for PdfiumRenderFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for PdfiumRenderFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for PdfiumRenderFlags

type Item = PdfiumRenderFlags

The type of the elements being iterated over.

type IntoIter = Iter<PdfiumRenderFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for PdfiumRenderFlags

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

Formats the value using the given formatter.

impl Not for PdfiumRenderFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = PdfiumRenderFlags

The resulting type after applying the ! operator.

impl Octal for PdfiumRenderFlags

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

Formats the value using the given formatter.

impl Ord for PdfiumRenderFlags

fn cmp(&self, other: &PdfiumRenderFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PdfiumRenderFlags

fn eq(&self, other: &PdfiumRenderFlags) -> 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 PartialOrd for PdfiumRenderFlags

fn partial_cmp(&self, other: &PdfiumRenderFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PublicFlags for PdfiumRenderFlags

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for PdfiumRenderFlags

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = PdfiumRenderFlags

The resulting type after applying the - operator.

impl SubAssign for PdfiumRenderFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for PdfiumRenderFlags

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

Formats the value using the given formatter.

impl Copy for PdfiumRenderFlags

impl Eq for PdfiumRenderFlags

impl StructuralPartialEq for PdfiumRenderFlags