Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: experimental:
encode_barcode_with_hints
function
experimental feature: encode barcodes using an encoding hint dictionary. This feature is untested, use at your own risk. The hints are as follows. ``` pub enum EncodeHintTypes { /** * 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. */ ErrorCorrection, /** * Specifies what character encoding to use where applicable (type {@link String}) */ CharacterSet, /** * Specifies the matrix shape for Data Matrix (type {@link com.google.zxing.datamatrix.encoder.SymbolShapeHint}) */ DataMatrixShape, /** * 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. */ DataMatrixCompact, /** * 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)} */ #[deprecated] MinSize, /** * Specifies a maximum barcode size (type {@link Dimension}). Only applicable to Data Matrix now. * * @deprecated without replacement */ #[deprecated] MaxSize, /** * 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). */ MARGIN, /** * Specifies whether to use compact mode for PDF417 (type {@link Boolean}, or "true" or "false" * {@link String} value). */ Pdf417Compact, /** * 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). */ Pdf417Compaction, /** * Specifies the minimum and maximum number of rows and columns for PDF417 (type * {@link com.google.zxing.pdf417.encoder.Dimensions Dimensions}). */ Pdf417Dimensions, /** * 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. */ Pdf417AutoEci, /** * 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). */ AztecLayers, /** * Specifies the exact version of QR code to be encoded. * (Type {@link Integer}, or {@link String} representation of the integer value). */ QrVersion, /** * 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). */ QrMaskPattern, /** * 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. */ QrCompact, /** * Specifies whether the data should be encoded to the GS1 standard (type {@link Boolean}, or "true" or "false" * {@link String } value). */ Gs1Format, /** * 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. */ ForceCodeSet, /** * 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. */ ForceC40, /** * 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. */ Code128Compact, /* * Will translate the numeric values received by the Telepen writer into the Telepen Alphanumeric form. */ TelepenAsNumeric, } ```
- Loading branch information