View Source Evision.QRCodeEncoder (Evision v0.2.9)

Summary

Types

t()

Type that represents an QRCodeEncoder struct.

Functions

create()

Constructor

create(named_args)

Constructor

encode(named_args)

encode(self, encoded_info)

Generates QR code from input string.

encode(self, encoded_info, opts)

Generates QR code from input string.

encodeStructuredAppend(named_args)

encodeStructuredAppend(self, encoded_info)

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

encodeStructuredAppend(self, encoded_info, opts)

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Types

t()

@type t() :: %Evision.QRCodeEncoder{ref: reference()}

Type that represents an QRCodeEncoder struct.

ref. reference()
The underlying erlang resource variable.

Functions

create()

@spec create() :: t() | {:error, String.t()}

Constructor

Keyword Arguments

parameters: Evision.QRCodeEncoder.Params.t().
QR code encoder parameters QRCodeEncoder::Params

Return

retval: Evision.QRCodeEncoder.t()

Python prototype (for reference only):

create([, parameters]) -> retval

create(named_args)

@spec create(Keyword.t()) :: any() | {:error, String.t()}

@spec create([{:parameters, term()}] | nil) :: t() | {:error, String.t()}

Constructor

Keyword Arguments

parameters: Evision.QRCodeEncoder.Params.t().
QR code encoder parameters QRCodeEncoder::Params

Return

retval: Evision.QRCodeEncoder.t()

Python prototype (for reference only):

create([, parameters]) -> retval

encode(named_args)

@spec encode(Keyword.t()) :: any() | {:error, String.t()}

encode(self, encoded_info)

@spec encode(t(), binary()) :: Evision.Mat.t() | {:error, String.t()}

Generates QR code from input string.

Positional Arguments

self: Evision.QRCodeEncoder.t()
encoded_info: String.
Input string to encode.

Return

qrcode: Evision.Mat.t().
Generated QR code.

Python prototype (for reference only):

encode(encoded_info[, qrcode]) -> qrcode

encode(self, encoded_info, opts)

@spec encode(t(), binary(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Generates QR code from input string.

Positional Arguments

self: Evision.QRCodeEncoder.t()
encoded_info: String.
Input string to encode.

Return

qrcode: Evision.Mat.t().
Generated QR code.

Python prototype (for reference only):

encode(encoded_info[, qrcode]) -> qrcode

encodeStructuredAppend(named_args)

@spec encodeStructuredAppend(Keyword.t()) :: any() | {:error, String.t()}

encodeStructuredAppend(self, encoded_info)

@spec encodeStructuredAppend(t(), binary()) ::
  [Evision.Mat.t()] | {:error, String.t()}

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Positional Arguments

self: Evision.QRCodeEncoder.t()
encoded_info: String.
Input string to encode.

Return

qrcodes: [Evision.Mat].
Vector of generated QR codes.

Python prototype (for reference only):

encodeStructuredAppend(encoded_info[, qrcodes]) -> qrcodes

encodeStructuredAppend(self, encoded_info, opts)

@spec encodeStructuredAppend(t(), binary(), [{atom(), term()}, ...] | nil) ::
  [Evision.Mat.t()] | {:error, String.t()}

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Positional Arguments

self: Evision.QRCodeEncoder.t()
encoded_info: String.
Input string to encode.

Return

qrcodes: [Evision.Mat].
Vector of generated QR codes.

Python prototype (for reference only):

encodeStructuredAppend(encoded_info[, qrcodes]) -> qrcodes