Enum microservices::StructuredFormat

#[non_exhaustive]
#[repr(u8)]pub enum StructuredFormat {
    Bin,
    Hex,
    Bech32,
    Base58,
    Base64,
    Json,
    Yaml,
    Toml,
}

Formats representing data structures supporting binary encoding and which can be represented by hierarchical data structures, including types supporting LNP/BP strict encoding, bitcoin consensus encoding (bitcoin::consensus::encode) or other bitcoin-specific binary encodings (BIP-32 specific encodings, PSBT encoding)

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.

Bin

Binary representation

Hex

Hexadecimal representation

Bech32

Bech32 representation

Base58

Base58 representation

Base64

Base64 representation

Json

JSON

Yaml

YAML

Toml

TOML

Trait Implementations

impl Clone for StructuredFormat

pub fn clone(&self) -> StructuredFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StructuredFormat

impl Debug for StructuredFormat

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

Formats the value using the given formatter.

impl Display for StructuredFormat

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

Formats the value using the given formatter.

impl Eq for StructuredFormat

impl FromStr for StructuredFormat

type Err = FormatParseError

The associated error which can be returned from parsing.

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

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

impl Hash for StructuredFormat

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for StructuredFormat

pub fn cmp(&self, other: &StructuredFormat) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<StructuredFormat> for StructuredFormat

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<StructuredFormat> for StructuredFormat

pub fn partial_cmp(&self, other: &StructuredFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StrictDecode for StructuredFormat

pub fn strict_decode<D: Read>(mut d: D) -> Result<Self, Error>

Decode with the given [std::io::Reader] instance; must either construct an instance or return implementation-specific error type.

pub fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using [strict_decode()]

impl StrictEncode for StructuredFormat

pub fn strict_encode<E: Write>(&self, mut e: E) -> Result<usize, Error>

Encode with the given [std::io::Writer] instance; must return result with either amount of bytes encoded – or implementation-specific error type.

pub fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using [strict_encode()] function

impl StructuralEq for StructuredFormat

impl StructuralPartialEq for StructuredFormat