Enum Message

pub enum Message<N: Network> {
    BlockRequest(BlockRequest),
    BlockResponse(BlockResponse<N>),
    ChallengeRequest(ChallengeRequest<N>),
    ChallengeResponse(ChallengeResponse<N>),
    Disconnect(Disconnect),
    PeerRequest(PeerRequest),
    PeerResponse(PeerResponse),
    Ping(Ping<N>),
    Pong(Pong),
    PuzzleRequest(PuzzleRequest),
    PuzzleResponse(PuzzleResponse<N>),
    UnconfirmedSolution(UnconfirmedSolution<N>),
    UnconfirmedTransaction(UnconfirmedTransaction<N>),
}

Variants

BlockRequest(BlockRequest)

BlockResponse(BlockResponse<N>)

ChallengeRequest(ChallengeRequest<N>)

ChallengeResponse(ChallengeResponse<N>)

Disconnect(Disconnect)

PeerRequest(PeerRequest)

PeerResponse(PeerResponse)

Ping(Ping<N>)

Pong(Pong)

PuzzleRequest(PuzzleRequest)

PuzzleResponse(PuzzleResponse<N>)

UnconfirmedSolution(UnconfirmedSolution<N>)

UnconfirmedTransaction(UnconfirmedTransaction<N>)

Implementations

impl<N: Network> Message<N>

pub const VERSIONS: [(ConsensusVersion, u32); 4]

The version of the network protocol; this is incremented for breaking changes between migration versions.

pub fn latest_message_version() -> u32

Returns the latest message version.

pub fn lowest_accepted_message_version(current_block_height: u32) -> u32

Returns the lowest acceptable message version for the given block height. Example scenario: At block height X, the protocol upgrades to message version from Y-1 to Y. Client A upgrades and starts using message version Y. Client B has not upgraded and still uses message version Y-1. Until block X, they stay connected and can communicate. After block X, Client A will reject messages from Client B.

pub fn name(&self) -> Cow<'static, str>

Returns the message name.

pub fn id(&self) -> u16

Returns the message ID.

pub fn check_size(bytes: &[u8]) -> Result<()>

Checks the message byte length. To be used before deserialization.

Trait Implementations

impl<N: Clone + Network> Clone for Message<N>

fn clone(&self) -> Message<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug + Network> Debug for Message<N>

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

Formats the value using the given formatter.

impl<N: Network> Encoder<Message<N>> for MessageCodec<N>

type Error = Error

The type of encoding errors.

fn encode( &mut self, message: Message<N>, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl<N: Network> From<DisconnectReason> for Message<N>

fn from(reason: DisconnectReason) -> Self

Converts to this type from the input type.

impl<N: Network> FromBytes for Message<N>

fn read_le<R: Read>(reader: R) -> Result<Self>

Reads Self from reader as little-endian bytes.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N: PartialEq + Network> PartialEq for Message<N>

fn eq(&self, other: &Message<N>) -> 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<N: Network> ToBytes for Message<N>

fn write_le<W: Write>(&self, writer: W) -> Result<()>

Writes self into writer as little-endian bytes.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Eq + Network> Eq for Message<N>

impl<N: Network> StructuralPartialEq for Message<N>