Enum Message 

#[non_exhaustive]
pub enum Message<I, A> {
    Ping(Ping<I, A>),
    IndirectPing(IndirectPing<I, A>),
    Ack(Ack),
    Suspect(Suspect<I>),
    Alive(Alive<I, A>),
    Dead(Dead<I>),
    PushPull(PushPull<I, A>),
    UserData(Bytes),
    Nack(Nack),
    ErrorResponse(ErrorResponse),
}

Request to be sent to the Raft node.

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.

Ping(Ping<I, A>)

Ping message

IndirectPing(IndirectPing<I, A>)

Indirect ping message

Ack(Ack)

Ack response message

Suspect(Suspect<I>)

Suspect message

Alive(Alive<I, A>)

Alive message

Dead(Dead<I>)

Dead message

PushPull(PushPull<I, A>)

PushPull message

UserData(Bytes)

User mesg, not handled by us

Nack(Nack)

Nack response message

ErrorResponse(ErrorResponse)

Error response message

Implementations

impl<I, A> Message<I, A>

pub const fn is_ping(&self) -> bool

Returns true if this value is of type Ping. Returns false otherwise

pub const fn is_indirect_ping(&self) -> bool

Returns true if this value is of type IndirectPing. Returns false otherwise

pub const fn is_ack(&self) -> bool

Returns true if this value is of type Ack. Returns false otherwise

pub const fn is_suspect(&self) -> bool

Returns true if this value is of type Suspect. Returns false otherwise

pub const fn is_alive(&self) -> bool

Returns true if this value is of type Alive. Returns false otherwise

pub const fn is_dead(&self) -> bool

Returns true if this value is of type Dead. Returns false otherwise

pub const fn is_push_pull(&self) -> bool

Returns true if this value is of type PushPull. Returns false otherwise

pub const fn is_user_data(&self) -> bool

Returns true if this value is of type UserData. Returns false otherwise

pub const fn is_nack(&self) -> bool

Returns true if this value is of type Nack. Returns false otherwise

pub const fn is_error_response(&self) -> bool

Returns true if this value is of type ErrorResponse. Returns false otherwise

impl<I, A> Message<I, A>

pub fn unwrap_ping(self) -> Ping<I, A>

Unwraps this value to the Message::Ping variant. Panics if this value is of any other type.

pub fn unwrap_indirect_ping(self) -> IndirectPing<I, A>

Unwraps this value to the Message::IndirectPing variant. Panics if this value is of any other type.

pub fn unwrap_ack(self) -> Ack

Unwraps this value to the Message::Ack variant. Panics if this value is of any other type.

pub fn unwrap_suspect(self) -> Suspect<I>

Unwraps this value to the Message::Suspect variant. Panics if this value is of any other type.

pub fn unwrap_alive(self) -> Alive<I, A>

Unwraps this value to the Message::Alive variant. Panics if this value is of any other type.

pub fn unwrap_dead(self) -> Dead<I>

Unwraps this value to the Message::Dead variant. Panics if this value is of any other type.

pub fn unwrap_push_pull(self) -> PushPull<I, A>

Unwraps this value to the Message::PushPull variant. Panics if this value is of any other type.

pub fn unwrap_user_data(self) -> Bytes

Unwraps this value to the Message::UserData variant. Panics if this value is of any other type.

pub fn unwrap_nack(self) -> Nack

Unwraps this value to the Message::Nack variant. Panics if this value is of any other type.

pub fn unwrap_error_response(self) -> ErrorResponse

Unwraps this value to the Message::ErrorResponse variant. Panics if this value is of any other type.

impl<I, A> Message<I, A>

pub fn try_unwrap_ping( self, ) -> Result<Ping<I, A>, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::Ping variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_indirect_ping( self, ) -> Result<IndirectPing<I, A>, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::IndirectPing variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_ack(self) -> Result<Ack, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::Ack variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_suspect( self, ) -> Result<Suspect<I>, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::Suspect variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_alive( self, ) -> Result<Alive<I, A>, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::Alive variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_dead(self) -> Result<Dead<I>, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::Dead variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_push_pull( self, ) -> Result<PushPull<I, A>, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::PushPull variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_user_data( self, ) -> Result<Bytes, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::UserData variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_nack(self) -> Result<Nack, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::Nack variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

pub fn try_unwrap_error_response( self, ) -> Result<ErrorResponse, TryUnwrapError<Message<I, A>>>

Attempts to unwrap this value to the Message::ErrorResponse variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

impl<I, A> Message<I, A>

pub const fn tag(&self) -> u8

Returns the tag of this message type for encoding/decoding.

pub const fn ty(&self) -> MessageType

Returns the type of the message.

pub const fn ping(val: Ping<I, A>) -> Message<I, A>

Construct a Message from Ping.

pub const fn indirect_ping(val: IndirectPing<I, A>) -> Message<I, A>

Construct a Message from IndirectPing.

pub const fn ack(val: Ack) -> Message<I, A>

Construct a Message from Ack.

pub const fn suspect(val: Suspect<I>) -> Message<I, A>

Construct a Message from Suspect.

pub const fn alive(val: Alive<I, A>) -> Message<I, A>

Construct a Message from Alive.

pub const fn dead(val: Dead<I>) -> Message<I, A>

Construct a Message from Dead.

pub const fn push_pull(val: PushPull<I, A>) -> Message<I, A>

Construct a Message from PushPull.

pub const fn user_data(val: Bytes) -> Message<I, A>

Construct a Message from Bytes.

pub const fn nack(val: Nack) -> Message<I, A>

Construct a Message from Nack.

pub const fn error_response(val: ErrorResponse) -> Message<I, A>

Construct a Message from ErrorResponse.

Trait Implementations

impl<I, A> Arbitrary for Message<I, A>

where I: Arbitrary, A: Arbitrary,

fn arbitrary(g: &mut Gen) -> Message<I, A>

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl<'arbitrary, I, A> Arbitrary<'arbitrary> for Message<I, A>

where I: Arbitrary<'arbitrary>, A: Arbitrary<'arbitrary>,

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Message<I, A>, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<Message<I, A>, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<I, A> Clone for Message<I, A>

where I: Clone, A: Clone,

fn clone(&self) -> Message<I, A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I, A> Data for Message<I, A>

where I: Data, A: Data,

type Ref<'a> = MessageRef<'a, <I as Data>::Ref<'a>, <A as Data>::Ref<'a>>

The reference type of the data.

fn from_ref( val: <Message<I, A> as Data>::Ref<'_>, ) -> Result<Message<I, A>, DecodeError>

where Message<I, A>: Sized,

Converts the reference type to the owned type.

fn encoded_len(&self) -> usize

Returns the encoded length of the data only considering the data itself, (e.g. no length prefix, no wire type).

fn encode(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message to a buffer.

const WIRE_TYPE: WireType = WireType::LengthDelimited

The wire type of the data.

fn encoded_len_with_length_delimited(&self) -> usize

Returns the encoded length of the data including the length delimited.

fn encode_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Available on crate features alloc or std only.

Encodes the message into a vec.

fn encode_to_bytes(&self) -> Result<Bytes, EncodeError>

Available on crate features alloc or std only.

Encodes the message into a Bytes.

fn encode_length_delimited(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Available on crate features alloc or std only.

Encodes the message with a length-delimiter into a vec.

fn encode_length_delimited_to_bytes(&self) -> Result<Bytes, EncodeError>

Available on crate features alloc or std only.

Encodes the message with a length-delimiter into a Bytes.

fn decode(src: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from the buffer.

impl<'a, I, A> DataRef<'a, Message<I, A>> for MessageRef<'a, <I as Data>::Ref<'a>, <A as Data>::Ref<'a>>

where I: Data, A: Data,

fn decode( src: &'a [u8], ) -> Result<(usize, MessageRef<'a, <I as Data>::Ref<'a>, <A as Data>::Ref<'a>>), DecodeError>

where MessageRef<'a, <I as Data>::Ref<'a>, <A as Data>::Ref<'a>>: Sized,

Decodes the reference type from a buffer.

fn decode_length_delimited(src: &'a [u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited reference instance of the message from the buffer.

impl<I, A> Debug for Message<I, A>

where I: Debug, A: Debug,

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

Formats the value using the given formatter.

impl<I, A> Eq for Message<I, A>

where I: Eq, A: Eq,

impl<I, A> From<Ack> for Message<I, A>

fn from(value: Ack) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<Alive<I, A>> for Message<I, A>

fn from(value: Alive<I, A>) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<Bytes> for Message<I, A>

fn from(value: Bytes) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<Dead<I>> for Message<I, A>

fn from(value: Dead<I>) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<ErrorResponse> for Message<I, A>

fn from(value: ErrorResponse) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<IndirectPing<I, A>> for Message<I, A>

fn from(value: IndirectPing<I, A>) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<Nack> for Message<I, A>

fn from(value: Nack) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<Ping<I, A>> for Message<I, A>

fn from(value: Ping<I, A>) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<PushPull<I, A>> for Message<I, A>

fn from(value: PushPull<I, A>) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> From<Suspect<I>> for Message<I, A>

fn from(value: Suspect<I>) -> Message<I, A>

Converts to this type from the input type.

impl<I, A> Hash for Message<I, A>

where I: Hash, A: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I, A> PartialEq for Message<I, A>

where I: PartialEq, A: PartialEq,

fn eq(&self, other: &Message<I, A>) -> 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<I, A> StructuralPartialEq for Message<I, A>

where I: PartialEq, A: PartialEq,