Struct PrinterProfile

pub struct PrinterProfile { /* private fields */ }

Details required to connect and print

In order to use the full functionality of the library, some information should be provided regarding the printer. The bare minimum information needed is the product id and the vendor id.

Implementations

impl PrinterProfile

pub fn new( printer_connection_data: PrinterConnectionData, columns_per_font: HashMap<Font, u8>, width: u16, ) -> PrinterProfile

Create custom printing details

Not recommended to use, as it contains a lot of arguments. See one of the builders instead (at the moment, only usb_builder and terminal_builder available).

pub fn usb_builder(vendor_id: u16, product_id: u16) -> PrinterProfileBuilder

Creates a PrinterProfileBuilder set for usb printing.

Equivalent to a call to PrinterProfileBuilder’s new_usb function.

use escpos_rs::PrinterProfile;
// Creates a minimum data structure to connect to a printer
let printer_profile = PrinterProfile::usb_builder(0x0001, 0x0001).build();

pub fn terminal_builder() -> PrinterProfileBuilder

Creates a PrinterProfileBuilder set for terminal printing

Equivalent to a call to PrinterProfileBuilder’s new_terminal function.

use escpos_rs::PrinterProfile;
// Creates a minimum data structure to connect to a printer
let printer_profile = PrinterProfile::terminal_builder().build();

Examples found in repository

examples/basic.rs (line 4)

fn main() {
    let printer_profile = PrinterProfile::terminal_builder().with_font_width(Font::FontA, 20).build();
    // We pass it to the printer
    let printer = match Printer::new(printer_profile) {
        Ok(maybe_printer) => match maybe_printer {
            Some(printer) => printer,
            None => panic!("No printer was found :(")
        },
        Err(e) => panic!("Error: {}", e)
    };
    
    // We print simple text
    match printer.println("Hello, world!") {
        Ok(_) => (),
        Err(e) => println!("Error: {}", e)
    }
}

examples/space_split.rs (line 4)

fn main() {
    let printer_profile = PrinterProfile::terminal_builder().with_font_width(Font::FontA, 32).build();
    // We pass it to the printer
    let mut printer = match Printer::new(printer_profile) {
        Ok(maybe_printer) => match maybe_printer {
            Some(printer) => printer,
            None => panic!("No printer was found :(")
        },
        Err(e) => panic!("Error: {}", e)
    };
    // We set word splitting
    printer.set_space_split(true);

    // We print simple text
    match printer.println("Really long sentence that should be splitted into three components, yay!") {
        Ok(_) => (),
        Err(e) => println!("Error: {}", e)
    }
}

examples/tables.rs (line 4)

fn main() {
    let printer_profile = PrinterProfile::terminal_builder().with_font_width(Font::FontA, 20).build();
    // We pass it to the printer
    let mut printer = match Printer::new(printer_profile) {
        Ok(maybe_printer) => match maybe_printer {
            Some(printer) => printer,
            None => panic!("No printer was found :(")
        },
        Err(e) => panic!("Error: {}", e)
    };
    // We set word splitting
    printer.set_space_split(true);
    
    println!("Table with two columns:");
    match printer.duo_table(("Product", "Price"), vec![
        ("Milk", "5.00"),
        ("Cereal", "10.00")
    ]) {
        Ok(_) => (),
        Err(e) => println!("Error: {}", e)
    }

    println!("Table with three columns:");
    match printer.trio_table(("Product", "Price", "Qty."), vec![
        ("Milk", "5.00", "3"),
        ("Cereal", "10.00", "1")
    ]) {
        Ok(_) => (),
        Err(e) => println!("Error: {}", e)
    }
}

Trait Implementations

impl Clone for PrinterProfile

fn clone(&self) -> PrinterProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrinterProfile

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

Formats the value using the given formatter.