Struct RenderOptions 

pub struct RenderOptions { /* private fields */ }

How a symbol should be drawn.

Defaults target a 300 DPI thermal shipping-label printer: a 13 mil X-dimension, 25 mm bar height, standard quiet zones, and human-readable text.

Examples

use smart_package_tracker::{Color, Length, QuietZone, RenderOptions};

let options = RenderOptions::builder()
    .module_width(Length::Mils(13.0))
    .height(Length::Mm(25.0))
    .quiet_zone(QuietZone::Standard)
    .dpi(300)
    .colors(Color::BLACK, Color::WHITE)
    .human_readable(true)
    .build()?;

assert_eq!(options.dpi(), 300);

Implementations

impl RenderOptions

pub fn builder() -> RenderOptionsBuilder

Start from the defaults and override what you need.

pub fn module_width(&self) -> Length

The X-dimension: width of one module.

pub fn height(&self) -> Length

Bar height, for linear symbologies.

pub fn quiet_zone(&self) -> QuietZone

Quiet zone setting.

pub fn dpi(&self) -> u32

Output resolution, used to convert physical lengths to pixels.

pub fn foreground(&self) -> Color

Colour of dark modules.

pub fn background(&self) -> Color

Colour of light modules and margins.

pub fn human_readable(&self) -> bool

Whether to print the payload beneath the symbol.

pub fn layout(&self, symbol: &Symbol) -> Result<Layout>

Compute the pixel geometry for symbol under these options.

Exposed because label layout often needs the final size before rendering.

Errors

Returns Error::InvalidRenderOptions if the result would exceed 20,000 pixels on either axis, or 64 megapixels in total.

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOptions

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

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RenderOptions

fn eq(&self, other: &RenderOptions) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RenderOptions