Struct Barcode

Source

pub struct Barcode { /* private fields */ }

Expand description

An encoded barcode, ready to render.

This is the type most callers work with. It pairs an encoded Symbol with convenience methods for the built-in renderers, while Barcode::render stays open to any Renderer implementation.

§Examples

use smart_package_tracker::{Barcode, RenderOptions, TrackingId};

let id = TrackingId::generate()?;
let barcode = Barcode::code128(&id)?;
let options = RenderOptions::default();

barcode.to_png_file("label.png", &options)?;
barcode.to_svg_file("label.svg", &options)?;

Implementations§

Source §

impl Barcode

Source

pub fn code128(data: impl AsRef<str>) -> Result<Self>

Available on crate feature code128 only.

Encode data as Code 128.

Accepts anything that borrows as a string, including TrackingId.

§Errors

Returns Error::EmptyPayload or Error::Unencodable.

Source

pub fn qr(data: impl AsRef<str>) -> Result<Self>

Available on crate feature qr only.

Encode data as a QR Code with default settings: medium error correction, and the smallest version that fits.

Use Barcode::qr_with to choose the error correction level or pin the version.

§Errors

Returns Error::EmptyPayload or Error::Unencodable.

Source

pub fn qr_with(encoder: Qr, data: impl AsRef<str>) -> Result<Self>

Available on crate feature qr only.

Encode data as a QR Code with an explicitly configured encoder.

§Examples

use smart_package_tracker::{Barcode, symbology::{Ecc, Qr, QrVersion}};

let barcode = Barcode::qr_with(
    Qr::new().ecc(Ecc::High).version(QrVersion::Fixed(6)),
    "PKG-9ED9285C",
)?;
assert_eq!(barcode.symbol().modules().width(), 41);

§Errors

Returns Error::EmptyPayload or Error::Unencodable.

Source

pub fn encode_with<S: Symbology + ?Sized>( symbology: &S, data: &str, ) -> Result<Self>

Encode data with any symbology.

§Errors

Propagates whatever the symbology reports.

Source

pub fn from_symbol(symbol: Symbol) -> Self

Wrap an already-encoded symbol.

Source

pub fn symbol(&self) -> &Symbol

The underlying symbol.

Source

pub fn payload(&self) -> &str

The payload this barcode encodes.

Source

pub fn kind(&self) -> SymbologyKind

Which symbology encoded it.

Source

pub fn render<R: Renderer>( &self, renderer: &R, options: &RenderOptions, ) -> Result<R::Output>

Render with an explicit renderer.

§Errors

Propagates renderer failures.

Source

pub fn to_png(&self, options: &RenderOptions) -> Result<Vec<u8>>

Available on crate feature png only.

Render to PNG bytes.

§Errors

Propagates renderer failures.

Source

pub fn to_svg(&self, options: &RenderOptions) -> Result<String>

Available on crate feature svg only.

Render to an SVG document.

§Errors

Propagates renderer failures.

Source

pub fn to_png_file( &self, path: impl AsRef<Path>, options: &RenderOptions, ) -> Result<()>

Available on crate features png and std only.

Render to PNG and write it to path.

§Errors

Propagates renderer failures and Error::Io.

Source

pub fn to_svg_file( &self, path: impl AsRef<Path>, options: &RenderOptions, ) -> Result<()>

Available on crate features std and svg only.

Render to SVG and write it to path.

§Errors

Propagates renderer failures and Error::Io.

Source

pub fn decode(&self) -> Result<String>

Available on crate feature code128 only.

Decode the barcode back into its payload from the module grid.

This does not simply return the stored payload: it reconstructs bar and space runs from the rendered module pattern and decodes those. A successful round trip is therefore evidence that the encoded geometry is correct.

This reads the symbol in memory. To read one out of an image, see scan.