Mab.PipelineFramework.BarcodeGenerator.Abstractions 1.0.0

PipelineFramework.BarcodeGenerator.Abstractions

Abstractions for barcode and QR code generation. This package provides interfaces, options, and result types for generating various barcode formats.

Installation

dotnet add package Mab.PipelineFramework.BarcodeGenerator.Abstractions

Overview

This package contains:

• Interfaces: IBarcodeGenerator, IQRCodeGenerator, IBarcodeGeneratorFactory
• Options: BarcodeOptions, QRCodeOptions, DataMatrixOptions
• Enums: BarcodeType, OutputFormat, ErrorCorrectionLevel
• Result Types: BarcodeResult, BarcodeMetadata, BarcodeError
• Utilities: BarcodeColor, BarcodeValidationResult

Supported Barcode Types

2D Barcodes (Matrix)

1D Barcodes (Linear)

Usage

Basic Interface Usage

public class InvoiceService
{
    private readonly IBarcodeGenerator _generator;

    public InvoiceService(IBarcodeGenerator generator)
    {
        _generator = generator;
    }

    public async Task<byte[]> CreateInvoiceBarcodeAsync(string invoiceId)
    {
        var result = await _generator.GenerateQRCodeAsync(
            $"INV:{invoiceId}",
            new QRCodeOptions
            {
                Width = 200,
                Height = 200,
                ErrorCorrectionLevel = ErrorCorrectionLevel.Medium
            });

        return result.GetDataOrThrow();
    }
}

Barcode Options

// 1D Barcode options
var barcodeOptions = new BarcodeOptions
{
    BarcodeType = BarcodeType.Code128,
    Width = 300,
    Height = 100,
    ShowText = true,
    ForegroundColor = BarcodeColor.Black,
    BackgroundColor = BarcodeColor.White
};

// QR Code options with logo
var qrOptions = new QRCodeOptions
{
    Width = 400,
    Height = 400,
    ErrorCorrectionLevel = ErrorCorrectionLevel.High,
    LogoData = File.ReadAllBytes("logo.png"),
    LogoSizeRatio = 0.2,
    ModuleShape = QRCodeModuleShape.RoundedSquare,
    UseGradient = true,
    GradientStartColor = BarcodeColor.FromHex("#1E3A8A"),
    GradientEndColor = BarcodeColor.FromHex("#7C3AED")
};

Result Handling

var result = generator.GenerateQRCode("https://example.com");

// Pattern matching
if (result.IsSuccess)
{
    // Save to file
    await result.SaveAsync("qrcode.png");

    // Or get as data URL for HTML
    var dataUrl = result.ToDataUrl();
    // <img src="{dataUrl}" />
}
else
{
    Console.WriteLine($"Error: {result.Error}");
}

// Functional style
result
    .OnSuccess((data, metadata) => Console.WriteLine($"Generated {metadata.SizeBytes} bytes"))
    .OnFailure(error => Console.WriteLine($"Failed: {error.Message}"));

// Match pattern
var message = result.Match(
    onSuccess: (data, meta) => $"Success! {meta.Width}x{meta.Height}",
    onFailure: error => $"Error: {error.Code}"
);

Color Utilities

// Predefined colors
var black = BarcodeColor.Black;
var white = BarcodeColor.White;

// From hex
var brand = BarcodeColor.FromHex("#FF5733");

// From HSL
var hsl = BarcodeColor.FromHsl(210, 0.8, 0.5);

// Check contrast (important for scanning)
if (!foreground.HasSufficientContrast(background))
{
    // Warning: low contrast may cause scanning issues
}

Related Packages

• Mab.PipelineFramework.BarcodeGenerator: Implementation package with QRCoder and ZXing.Net