Skip to main content

AZTecDecoder

Struct AZTecDecoder 

Source
pub struct AZTecDecoder { /* private fields */ }
Expand description

Klient dekodera kodów AZTEC 2D z dowodów rejestracyjnych (Web API).

Komunikuje się z usługą Web API pod adresem https://www.pelock.com/api/aztec-decoder/v1.

§Przykład

use aztec_decoder::AZTecDecoder;

let decoder = AZTecDecoder::new("ABCD-ABCD-ABCD-ABCD");
let result = decoder.decode_text("ggMAANtYAAJD...").await?;
println!("{}", serde_json::to_string_pretty(&result)?);

Implementations§

Source§

impl AZTecDecoder

Source

pub fn new(api_key: impl Into<String>) -> Self

Tworzy nową instancję dekodera.

§Argumenty
  • api_key – klucz do usługi Web API
Source

pub async fn decode_text(&self, text: &str) -> Result<Value, AZTecError>

Dekoduje zaszyfrowaną wartość tekstową do wyjściowej struktury JSON.

Wysyła polecenie decode-text wraz z podanym tekstem (np. odczytanym skanerem w formacie Base64) do serwera Web API.

§Argumenty
  • text – odczytana wartość kodu AZTEC 2D w formie ASCII
§Błędy

Zwraca AZTecError w przypadku pustego klucza API, błędu sieciowego lub nieprawidłowej odpowiedzi JSON.

Source

pub async fn decode_text_from_file( &self, path: impl AsRef<Path>, ) -> Result<Value, AZTecError>

Dekoduje zaszyfrowaną wartość tekstową ze wskazanego pliku do wyjściowej struktury JSON.

Odczytuje zawartość pliku jako UTF-8 i przekazuje ją do decode_text.

§Argumenty
  • path – ścieżka do pliku z odczytaną wartością kodu AZTEC 2D
§Błędy

Zwraca AZTecError::FileRead jeśli plik nie istnieje lub nie można go odczytać, oraz pozostałe warianty AZTecError w przypadku błędów komunikacji z API.

Source

pub async fn decode_image_from_file( &self, path: impl AsRef<Path>, ) -> Result<Value, AZTecError>

Dekoduje zaszyfrowaną wartość zakodowaną w obrazku PNG lub JPG/JPEG do wyjściowej struktury JSON.

Wysyła plik graficzny jako formularz multipart z poleceniem decode-image do serwera Web API.

§Argumenty
  • path – ścieżka do obrazka z kodem AZTEC 2D
§Błędy

Zwraca AZTecError::FileRead jeśli plik nie istnieje lub nie można go odczytać, oraz pozostałe warianty AZTecError w przypadku błędów komunikacji z API.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more