lightning_encoding 0.9.3

Network encoding for lightning network peer protocol data types
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
54

// Network encoding for lightning network peer protocol data types
// Written in 2020-2022 by
//     Dr. Maxim Orlovsky <orlovsky@pandoracore.com>
//
// To the extent possible under law, the author(s) have dedicated all
// copyright and related and neighboring rights to this software to
// the public domain worldwide. This software is distributed without
// any warranty.
//
// You should have received a copy of the MIT License
// along with this software.
// If not, see <https://opensource.org/licenses/MIT>.

use amplify::IoError;
use strict_encoding::TlvError;

#[derive(Clone, PartialEq, Eq, Hash, Debug, Display, Error, From)]
#[display(doc_comments)]
pub enum Error {
    /// I/O error
    #[from(std::io::Error)]
    #[from(std::io::ErrorKind)]
    #[display(inner)]
    Io(IoError),

    /// decoded BigSize is not canonical
    BigSizeNotCanonical,

    /// unexpected EOF while decoding BigSize value
    BigSizeEof,

    /// Indicates absence of BigSize value. Used in TLV stream reading
    #[display("unexpected EOF while decoding BigSize value")]
    BigSizeNoValue,

    /// not all provided data were consumed during decoding process
    DataNotEntirelyConsumed,

    /// Custom type-specific error
    #[display(inner)]
    DataIntegrityError(String),

    /// TLV encoding error
    #[from]
    #[display(inner)]
    Tlv(TlvError),

    /// unsupported value `{0}` for enum `{0}` encountered during decode
    /// operation
    EnumValueNotKnown(&'static str, usize),

    /// data size {0} exceeds maximum allowed for the lightning message
    TooLargeData(usize),
}