xBarcode API

Overview

Supported Barcodes (34 Types)

1D Linear Barcodes

2D Matrix/Stacked Barcodes

GTIN Family

API Reference

Core Functions

Encoder Trait

pub trait Encoder {
    fn encode(&self, contents: &str) -> Result<BitMatrix, BarcodeError>;
    fn barcode_type(&self) -> BarcodeType;
    fn format_name(&self) -> &'static str;
}

Configuration Options

RenderConfig

Default Values by Barcode Type

Color Formats

// HEX format
Color::hex("#FF0000")      // Red
Color::hex("#FF000080")    // Red with 50% alpha

// sRGB format (0.0-1.0)
Color::srgb(1.0, 0.0, 0.0)           // Red
Color::srgba(1.0, 0.0, 0.0, 0.5)     // Red with 50% alpha

// RGB format (0-255)
Color::rgb(255, 0, 0)      // Red

// Predefined
Color::BLACK
Color::WHITE
Color::TRANSPARENT

Code Examples

Basic Usage

use xbarcode::{create_encoder, render_svg_configured, RenderConfig};

// Create encoder
let encoder = create_encoder("qrcode").unwrap();

// Encode data
let matrix = encoder.encode("Hello, World!").unwrap();

// Render to SVG with defaults
let svg = render_svg_configured(&matrix, &RenderConfig::default_svg(), "qrcode");

Custom Configuration

use xbarcode::{
    create_encoder, render_svg_configured, render_eps,
    Color, RenderConfig, Rotation, QuietZone, OutputSize, OutputFormat,
};

let encoder = create_encoder("datamatrix").unwrap();
let matrix = encoder.encode("Product ID: 12345").unwrap();

// Custom render config
let config = RenderConfig {
    format: OutputFormat::SVG,
    fg_color: Color::hex("#1a1a2e").unwrap(),
    bg_color: Some(Color::WHITE),
    rotation: Rotation::R90,
    quiet_zone: QuietZone::Standard,
    size: OutputSize::ModulePixels(8),
};

let svg = render_svg_configured(&matrix, &config, "datamatrix");
let eps = render_eps(&matrix, &config, "datamatrix");

List Supported Formats

use xbarcode::supported_formats;

for format in supported_formats() {
    println!("{}", format);
}
// Output: qrcode, datamatrix, pdf417, code128, ean13, ...

Technical Standards