Struct ZplEngine 

pub struct ZplEngine { /* private fields */ }

The main entry point for processing and rendering ZPL labels.

ZplEngine holds the parsed instructions, label dimensions, and configuration required to render a label using a specific backend.

Implementations

impl ZplEngine

pub fn new( zpl: &str, width: Unit, height: Unit, resolution: Resolution, ) -> ZplResult<Self>

Creates a new ZplEngine instance by parsing a ZPL string.

Arguments

• zpl - The raw ZPL string to parse.
• width - The physical width of the label.
• height - The physical height of the label.
• resolution - The printing resolution (DPI).

Errors

Returns an error if the ZPL is invalid or if the instruction building fails.

Examples found in repository

examples/basic.rs (lines 15-20)

fn main() {
    let zpl_input = r#"
        ^XA
        ^FO50,50^A0N,50,50^FDZPL Forge^FS
        ^FO50,120^GB300,100,2^FS
        ^FO70,140^A0N,30,30^FDHello World!^FS
        ^FO50,250^BCN,100,Y,N,N^FD12345678^FS
        ^XZ
    "#;

    let engine = ZplEngine::new(
        zpl_input,
        Unit::Inches(4.0),
        Unit::Inches(3.0),
        Resolution::Dpi203,
    )
    .expect("Error parsing ZPL");

    let png_backend = PngBackend::new();
    let png_bytes = engine
        .render(png_backend, &HashMap::new())
        .expect("Error rendering");

    std::fs::write("example_output.png", png_bytes).expect("Error writing file");
    println!("Label successfully generated in 'example_output.png'");
}

pub fn set_fonts(&mut self, fonts: Arc<FontManager>)

Sets the font manager to be used during rendering.

If no font manager is provided, a default one will be used.

pub fn render<B: ZplForgeBackend>( &self, backend: B, variables: &HashMap<String, String>, ) -> ZplResult<Vec<u8>>

Renders the parsed instructions using the provided backend.

Arguments

• backend - An implementation of ZplForgeBackend (e.g., PNG, PDF).
• variables - A map of template variables to replace in text fields (format: {{key}}).

Errors

Returns an error if rendering fails at the backend level.

Examples found in repository

examples/basic.rs (line 25)

fn main() {
    let zpl_input = r#"
        ^XA
        ^FO50,50^A0N,50,50^FDZPL Forge^FS
        ^FO50,120^GB300,100,2^FS
        ^FO70,140^A0N,30,30^FDHello World!^FS
        ^FO50,250^BCN,100,Y,N,N^FD12345678^FS
        ^XZ
    "#;

    let engine = ZplEngine::new(
        zpl_input,
        Unit::Inches(4.0),
        Unit::Inches(3.0),
        Resolution::Dpi203,
    )
    .expect("Error parsing ZPL");

    let png_backend = PngBackend::new();
    let png_bytes = engine
        .render(png_backend, &HashMap::new())
        .expect("Error rendering");

    std::fs::write("example_output.png", png_bytes).expect("Error writing file");
    println!("Label successfully generated in 'example_output.png'");
}

Trait Implementations

impl Debug for ZplEngine

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

Formats the value using the given formatter.