Struct EncodeHints 

pub struct EncodeHints {

    pub ErrorCorrection: Option<String>,
    pub CharacterSet: Option<String>,
    pub DataMatrixShape: Option<SymbolShapeHint>,
    pub DataMatrixCompact: Option<bool>,
    pub MinSize: Option<Dimension>,
    pub MaxSize: Option<Dimension>,
    pub Margin: Option<String>,
    pub Pdf417Compact: Option<String>,
    pub Pdf417Compaction: Option<String>,
    pub Pdf417Dimensions: Option<Dimensions>,
    pub Pdf417AutoEci: Option<String>,
    pub AztecLayers: Option<i32>,
    pub QrVersion: Option<String>,
    pub QrMaskPattern: Option<String>,
    pub QrCompact: Option<String>,
    pub Gs1Format: Option<bool>,
    pub ForceCodeSet: Option<String>,
    pub ForceC40: Option<bool>,
    pub Code128Compact: Option<bool>,
    pub TelepenAsNumeric: Option<bool>,
}

Fields

ErrorCorrection: Option<String>

Specifies what degree of error correction to use, for example in QR Codes. Type depends on the encoder. For example for QR codes it’s type {@link com.google.zxing.qrcode.decoder.ErrorCorrectionLevel ErrorCorrectionLevel}. For Aztec it is of type {@link Integer}, representing the minimal percentage of error correction words. For PDF417 it is of type {@link Integer}, valid values being 0 to 8. In all cases, it can also be a {@link String} representation of the desired value as well. Note: an Aztec symbol should have a minimum of 25% EC words.

CharacterSet: Option<String>

Specifies what character encoding to use where applicable (type {@link String})

DataMatrixShape: Option<SymbolShapeHint>

Specifies the matrix shape for Data Matrix (type {@link com.google.zxing.datamatrix.encoder.SymbolShapeHint})

DataMatrixCompact: Option<bool>

Specifies whether to use compact mode for Data Matrix (type {@link Boolean}, or “true” or “false” {@link String } value). The compact encoding mode also supports the encoding of characters that are not in the ISO-8859-1 character set via ECIs. Please note that in that case, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint. Compact encoding also provides GS1-FNC1 support when {@link #GS1_FORMAT} is selected. In this case group-separator character (ASCII 29 decimal) can be used to encode the positions of FNC1 codewords for the purpose of delimiting AIs. This option and {@link #FORCE_C40} are mutually exclusive.

MinSize: Option<Dimension>

👎Deprecated

Specifies a minimum barcode size (type {@link Dimension}). Only applicable to Data Matrix now.

@deprecated use width/height params in {@link com.google.zxing.datamatrix.DataMatrixWriter#encode(String, BarcodeFormat, int, int)}

MaxSize: Option<Dimension>

👎Deprecated

Specifies a maximum barcode size (type {@link Dimension}). Only applicable to Data Matrix now.

@deprecated without replacement

Margin: Option<String>

Specifies margin, in pixels, to use when generating the barcode. The meaning can vary by format; for example it controls margin before and after the barcode horizontally for most 1D formats. (Type {@link Integer}, or {@link String} representation of the integer value).

Pdf417Compact: Option<String>

Specifies whether to use compact mode for PDF417 (type {@link Boolean}, or “true” or “false” {@link String} value).

Pdf417Compaction: Option<String>

Specifies what compaction mode to use for PDF417 (type {@link com.google.zxing.pdf417.encoder.Compaction Compaction} or {@link String} value of one of its enum values).

Pdf417Dimensions: Option<Dimensions>

Specifies the minimum and maximum number of rows and columns for PDF417 (type {@link com.google.zxing.pdf417.encoder.Dimensions Dimensions}).

Pdf417AutoEci: Option<String>

Specifies whether to automatically insert ECIs when encoding PDF417 (type {@link Boolean}, or “true” or “false” {@link String} value). Please note that in that case, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint.

AztecLayers: Option<i32>

Specifies the required number of layers for an Aztec code. A negative number (-1, -2, -3, -4) specifies a compact Aztec code. 0 indicates to use the minimum number of layers (the default). A positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code. (Type {@link Integer}, or {@link String} representation of the integer value).

QrVersion: Option<String>

Specifies the exact version of QR code to be encoded. (Type {@link Integer}, or {@link String} representation of the integer value).

QrMaskPattern: Option<String>

Specifies the QR code mask pattern to be used. Allowed values are 0..QRCode.NUM_MASK_PATTERNS-1. By default the code will automatically select the optimal mask pattern.

• (Type {@link Integer}, or {@link String} representation of the integer value).

QrCompact: Option<String>

Specifies whether to use compact mode for QR code (type {@link Boolean}, or “true” or “false” {@link String } value). Please note that when compaction is performed, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint.

Gs1Format: Option<bool>

Specifies whether the data should be encoded to the GS1 standard (type {@link Boolean}, or “true” or “false” {@link String } value).

ForceCodeSet: Option<String>

Forces which encoding will be used. Currently only used for Code-128 code sets (Type {@link String}). Valid values are “A”, “B”, “C”. This option and {@link #CODE128_COMPACT} are mutually exclusive.

ForceC40: Option<bool>

Forces C40 encoding for data-matrix (type {@link Boolean}, or “true” or “false”) {@link String } value). This option and {@link #DATA_MATRIX_COMPACT} are mutually exclusive.

Code128Compact: Option<bool>

Specifies whether to use compact mode for Code-128 code (type {@link Boolean}, or “true” or “false” {@link String } value). This can yield slightly smaller bar codes. This option and {@link #FORCE_CODE_SET} are mutually exclusive.

TelepenAsNumeric: Option<bool>

Translate the numeric values received by the Telepen reader into the Telepen Alphaumeric form; use {@link Boolean#TRUE}.

Implementations

impl EncodeHints

pub fn with(self, hint: EncodeHintValue) -> Self

Trait Implementations

impl Clone for EncodeHints

fn clone(&self) -> EncodeHints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncodeHints

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

Formats the value using the given formatter.

impl Default for EncodeHints

fn default() -> EncodeHints

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EncodeHints

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<HashMap<EncodeHintType, EncodeHintValue>> for EncodeHints

fn from(value: EncodingHintDictionary) -> Self

Converts to this type from the input type.

impl Serialize for EncodeHints

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.