Enum Canonicality 

#[non_exhaustive]
pub enum Canonicality {
    Canonical,
    NonCanonical {
        offset: usize,
        message: String,
    },
}

Result of metainfo-only validation. Canonical encoding status for parseable source bytes.

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.

Canonical

The original bytes are canonical bencode.

NonCanonical

The original bytes are parseable but not canonical.

Fields

offset: usize

Byte offset where canonical validation detected the issue.

message: String

Human-readable canonicality explanation.

Implementations

impl Canonicality

pub const fn is_canonical(&self) -> bool

Returns true when the original source is canonically encoded.

pub const fn offset(&self) -> Option<usize>

Returns the canonicality issue offset, when non-canonical.

pub fn message(&self) -> Option<&str>

Returns the canonicality explanation, when non-canonical.

Trait Implementations

impl Clone for Canonicality

fn clone(&self) -> Canonicality

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Canonicality

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

Formats the value using the given formatter.

impl Default for Canonicality

fn default() -> Canonicality

Returns the “default value” for a type.

impl PartialEq for Canonicality

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Canonicality

impl StructuralPartialEq for Canonicality