Skip to main content

TokenUrDecoder

Struct TokenUrDecoder 

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

Reassembles a Token from scanned UR fragments

QR frames are fed with receive as they are scanned, in any order; complete reports when enough frames have been seen and token returns the reassembled token.

Implementations§

Source§

impl TokenUrDecoder

Source

pub fn receive(&mut self, part: &str) -> Result<(), Error>

Feeds one scanned QR frame into the decoder

Accepts both multi-part fragments (ur:bytes/<seq>-<len>/<payload>) and the single-part form (ur:bytes/<payload>).

§Errors

Returns an error if the frame is not a well-formed ur:bytes UR, is inconsistent with previously received frames, exceeds the decoder resource limits, or fails checksum validation.

Source

pub fn complete(&self) -> bool

Returns whether the token has been fully reassembled

Source

pub fn token(&self) -> Result<Option<Token>, Error>

Returns the reassembled Token once complete

Returns None while decoding is incomplete.

§Errors

Returns an error if the reassembled payload is not a valid token.

Source

pub fn fragment_count(&self) -> usize

Returns the total number of fragments the token was split into

This is 0 until the first multi-part fragment is received.

Source

pub fn resolved_fragment_count(&self) -> Option<usize>

Returns the number of fragments resolved so far, either received directly or recovered via the fountain code

Useful for progress indication. Returns None before any fragment has been received.

Trait Implementations§

Source§

impl Debug for TokenUrDecoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TokenUrDecoder

Source§

fn default() -> TokenUrDecoder

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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