ens-normalize-rs 0.2.0

Ethereum Name Service (ENS) name normalization
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

use crate::CodePoint;

/// Errors that can occur during processing of an ENS name.
#[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)]
pub enum ProcessError {
    #[error("contains visually confusing characters from multiple scripts: {0}")]
    Confused(String),
    #[error("contains visually confusing characters from {group1} and {group2} scripts")]
    ConfusedGroups { group1: String, group2: String },
    #[error("invalid character ('{sequence}') at position {index}: {inner}")]
    CurrableError {
        inner: CurrableError,
        index: usize,
        sequence: String,
        maybe_suggest: Option<String>,
    },
    #[error("disallowed sequence: {0}")]
    DisallowedSequence(#[from] DisallowedSequence),
}

/// Errors that can be cured by the normalizer.
#[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)]
pub enum CurrableError {
    #[error("underscore in middle")]
    UnderscoreInMiddle,
    #[error("hyphen at second and third position")]
    HyphenAtSecondAndThird,
    #[error("combining mark in disallowed position at the start of the label")]
    CmStart,
    #[error("combining mark in disallowed position after an emoji")]
    CmAfterEmoji,
    #[error("fenced character at the start of a label")]
    FencedLeading,
    #[error("fenced character at the end of a label")]
    FencedTrailing,
    #[error("consecutive sequence of fenced characters")]
    FencedConsecutive,
}

/// Errors regarding disallowed sequences.
#[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)]
pub enum DisallowedSequence {
    #[error("disallowed character: {0}")]
    Invalid(String),
    #[error("invisible character: {0}")]
    InvisibleCharacter(CodePoint),
    #[error("empty label")]
    EmptyLabel,
    #[error("nsm too many")]
    NsmTooMany,
    #[error("nsm repeated")]
    NsmRepeated,
}