Enum RevealFormat 

#[non_exhaustive]
pub enum RevealFormat {
    Paper32,
    Hex,
    Bip39,
}

An encoding a value is shown in.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Paper32

Rows of 32 base-32 characters, 28 of data and 4 of parity, from an alphabet without I, L, O and U; a wrong character in a row is corrected, two unreadable ones recovered. The default. See paper32.

Hex

Two hexadecimal digits per byte, upper case, in rows of 32.

Bip39

Words from the BIP-39 English list, one per row, as a hardware wallet shows its recovery phrase and takes it back. For entropy of 16 to 32 bytes in steps of 4. See bip39.

Implementations

impl RevealFormat

pub fn as_str(self) -> &'static str

The name a ceremony writes.

pub fn is_words(self) -> bool

Whether the value is words, one per row, rather than characters.

pub fn unit(self) -> &'static str

What length: counts in this format, as a person reads it.

pub fn length_of(self, bytes: usize) -> usize

A value of bytes bytes in this format’s unit: bytes, or the words of a phrase.

pub fn bytes_for(self, length: usize) -> usize

The bytes a length: in this format’s unit stands for.

pub fn layout(self) -> Layout

The shape a sheet takes for this encoding.

pub fn layout_for(format: Option<Self>) -> Layout

The shape a reveal step gives from its definition: its format, or the default.

pub fn rows(self, bytes: usize) -> usize

Rows a value of bytes bytes takes.

pub fn read_row( self, text: &str, row: usize, more: bool, ) -> Result<TypedRow, String>

One row as typed, checked on its own: the characters it should be, and the repair it took, in words. row is its number from 1, and more says rows are known to follow it.

Every row but the last is full, since a row’s place in the value is its position: a short row is the last one, and one with rows after it is a row with characters missing.

use rite_model::RevealFormat;

let row = RevealFormat::Paper32.read_row("E9MQ 8S8P H8B", 1, false).unwrap();
assert_eq!(row.text.as_str(), "E9MQ8S8PH8B");
assert!(!row.full);
// A short row where more are to come has characters missing.
assert!(RevealFormat::Paper32.read_row("E9MQ8S8PH8B", 1, true).is_err());

Errors

What is wrong with the row, in words, for the person to fix.

pub fn decode(self, text: &str) -> Result<TypedValue, String>

A whole value as typed, rows one after another: its bytes, and the repairs it took, in words.

Errors

What is wrong with the text, in words.

pub fn characters(self, bytes: usize) -> usize

Characters a value of bytes bytes takes, parity included.

Trait Implementations

impl Clone for RevealFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RevealFormat

impl Debug for RevealFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RevealFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RevealFormat

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

Formats the value using the given formatter.

impl Eq for RevealFormat

impl FromStr for RevealFormat

type Err = UnknownRevealFormat

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for RevealFormat

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RevealFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RevealFormat