Skip to main content

Encoder

Struct Encoder 

Source
pub struct Encoder { /* private fields */ }
Available on crate feature micro-qr only.
Expand description

Configures and encodes Micro QR Code symbols.

Implementations§

Source§

impl MicroEncoder

Source

pub const fn new(error_correction: MicroErrorCorrection) -> Self

Creates an encoder with automatic mask selection and all Micro QR Code versions.

Source

pub const fn version(self, version: MicroVersion) -> Self

Selects one exact Micro QR Code version.

Source

pub const fn version_range(self, versions: RangeInclusive<MicroVersion>) -> Self

Selects the inclusive Micro QR Code version range considered during encoding.

Source

pub const fn mask(self, mask: MicroMask) -> Self

Forces an exact mask instead of selecting one automatically.

Source

pub const fn boost_error_correction(self, boost: bool) -> Self

Enables or disables upgrading the error correction level when the selected version has room.

Source

pub fn encode_bytes( &self, data: impl AsRef<[u8]>, ) -> Result<Symbol, EncodeError>

Encodes raw bytes with globally optimized modes supported by each candidate version.

Source

pub fn encode_text(&self, text: impl AsRef<str>) -> Result<Symbol, EncodeError>

Encodes text with globally optimized modes supported by each candidate version.

Source

pub fn encode_to_qr_text<T: ToQRText + ?Sized>( &self, value: &T, ) -> Result<Symbol, EncodeError>

Encodes a value after converting it to its QR Code text representation.

Source

pub fn encode_segments( &self, segments: &[Segment], ) -> Result<Symbol, EncodeError>

Encodes explicit segments without changing their boundaries.

The segments are written as given, so avoid Byte segments holding E0 to EB in a symbol with Kanji segments, because readers could take them for Shift JIS lead bytes. An empty Numeric segment is left out, because Micro QR Code writes it with the same bits as the terminator.

Trait Implementations§

Source§

impl Clone for MicroEncoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MicroEncoder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.