koibumi-core 0.0.9

The core library for Koibumi, an experimental Bitmessage client
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Message types defined in the Bitmessage protocol.

mod error;
pub use crate::message::error::{Error, ErrorText, Fatal};

mod getdata;
pub use crate::message::getdata::Getdata;

mod inv;
pub use crate::message::inv::Inv;

// TODO Dinv
//mod dinv;
//pub use crate::message::dinv::Dinv;

mod object;
pub use crate::message::object::Object;

mod addr;
pub use crate::message::addr::Addr;

// TODO Portcheck
//mod portcheck;
//pub use crate::message::portcheck::Portcheck;

mod ping;
pub use crate::message::ping::Ping;

mod pong;
pub use crate::message::pong::Pong;

mod verack;
pub use crate::message::verack::Verack;

mod version;
pub use crate::message::version::{NodeNonce, ProtocolVersion, UserAgent, Version};

use std::{
    fmt,
    io::{self, Read, Write},
};

use crate::{
    config::Config,
    io::{ReadFrom, WriteTo},
    packet::{self, Command, Packet},
    priv_util::ToHexString,
};

pub use crate::{
    io::TooLongError,
    net_addr::{NetAddr, Services},
    stream::{StreamNumber, StreamNumbers},
};

/// Indicates that this object is a Bitmessage message
/// and informs what type of message it is.
pub trait Message {
    /// What type of message this is.
    const COMMAND: Command;
}

/// Provides a method that creates a Bitmessage packet from the Bitmessage message.
pub trait Pack {
    /// Returns a Bitmessage packet created from the Bitmessage message.
    fn pack(&self, config: &Config) -> packet::Result<Packet>;
}

impl<T> Pack for T
where
    T: WriteTo + Message,
{
    fn pack(&self, config: &Config) -> packet::Result<Packet> {
        let mut bytes = Vec::new();
        self.write_to(&mut bytes).unwrap();
        Packet::new(config, Self::COMMAND, bytes)
    }
}

/// A hash value of an object message, used to specify the object message.
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub struct InvHash([u8; 32]);

impl InvHash {
    /// Constructs an inventory hash from a byte array.
    pub fn new(value: [u8; 32]) -> Self {
        Self(value)
    }
}

impl fmt::Display for InvHash {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.to_hex_string().fmt(f)
    }
}

impl AsRef<[u8]> for InvHash {
    fn as_ref(&self) -> &[u8] {
        &self.0
    }
}

impl WriteTo for InvHash {
    fn write_to(&self, w: &mut dyn Write) -> io::Result<()> {
        self.0.write_to(w)
    }
}

impl ReadFrom for InvHash {
    fn read_from(r: &mut dyn Read) -> io::Result<Self>
    where
        Self: Sized,
    {
        Ok(Self(<[u8; 32]>::read_from(r)?))
    }
}