Struct rxing::MultiFormatReader

pub struct MultiFormatReader { /* private fields */ }

MultiFormatReader is a convenience class and the main entry point into the library for most uses. By default it attempts to decode all barcode formats that the library supports. Optionally, you can provide a hints object to request different behavior, for example only decoding QR codes.

@author Sean Owen @author dswitkin@google.com (Daniel Switkin)

Implementations

impl MultiFormatReader

pub fn decode_with_state(
    &mut self,
    image: &mut BinaryBitmap
) -> Result<RXingResult, Exceptions>

Decode an image using the state set up by calling setHints() previously. Continuous scan clients will get a large speed increase by using this instead of decode().

@param image The pixel data to decode @return The contents of the image @throws NotFoundException Any errors which occurred

pub fn set_ints(&mut self, hints: &DecodingHintDictionary)

This method adds state to the MultiFormatReader. By setting the hints once, subsequent calls to decodeWithState(image) can reuse the same set of readers without reallocating memory. This is important for performance in continuous scan clients.

@param hints The set of hints to use for subsequent calls to decode(image)

pub fn decode_internal(
    &mut self,
    image: &mut BinaryBitmap
) -> Result<RXingResult, Exceptions>

Trait Implementations

impl Default for MultiFormatReader

fn default() -> MultiFormatReader

Returns the “default value” for a type.

impl Reader for MultiFormatReader

fn decode(&mut self, image: &mut BinaryBitmap) -> Result<RXingResult, Exceptions>

This version of decode honors the intent of Reader.decode(BinaryBitmap) in that it passes null as a hint to the decoders. However, that makes it inefficient to call repeatedly. Use setHints() followed by decodeWithState() for continuous scan applications.

@param image The pixel data to decode @return The contents of the image @throws NotFoundException Any errors which occurred

fn decode_with_hints(
    &mut self,
    image: &mut BinaryBitmap,
    hints: &DecodingHintDictionary
) -> Result<RXingResult, Exceptions>

Decode an image using the hints provided. Does not honor existing state.

@param image The pixel data to decode @param hints The hints to use, clearing the previous state. @return The contents of the image @throws NotFoundException Any errors which occurred

fn reset(&mut self)

Resets any internal state the implementation has after a decode, to prepare it for reuse.