Struct PushPull 

pub struct PushPull<I, A> {
    pub join: bool,
    pub states: Arc<[PushNodeState<I, A>]>,
    pub user_data: Bytes,
}

Push pull message.

Fields

join: bool

Whether the push pull message is a join message.

states: Arc<[PushNodeState<I, A>]>

The states of the push pull message.

user_data: Bytes

The user data of the push pull message.

Implementations

impl<I, A> PushPull<I, A>

pub const fn join(&self) -> bool

Returns whether the push pull message is a join message

pub const fn states(&self) -> &Arc<[PushNodeState<I, A>]>

Returns the states of the push pull message

pub const fn user_data(&self) -> &Bytes

Returns the user data of the push pull message

pub const fn with_join(self, val: bool) -> PushPull<I, A>

Sets whether the push pull message is a join message (Builder pattern)

pub fn with_states(self, val: Arc<[PushNodeState<I, A>]>) -> PushPull<I, A>

Sets the states of the push pull message (Builder pattern)

pub fn with_user_data(self, val: Bytes) -> PushPull<I, A>

Sets the user data of the push pull message (Builder pattern)

impl<I, A> PushPull<I, A>

pub fn new( join: bool, states: impl Iterator<Item = PushNodeState<I, A>>, ) -> PushPull<I, A>

Create a new PushPull message.

pub fn into_components(self) -> (bool, Bytes, Arc<[PushNodeState<I, A>]>)

Consumes the PushPull and returns the states and user data.

Trait Implementations

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

where I: Arbitrary, A: Arbitrary,

fn arbitrary(g: &mut Gen) -> PushPull<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 PushPull<I, A>

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

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

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

fn arbitrary_take_rest( u: Unstructured<'arbitrary>, ) -> Result<PushPull<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> CheapClone for PushPull<I, A>

fn cheap_clone(&self) -> PushPull<I, A>

Returns a copy of the value.

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

fn clone(&self) -> PushPull<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 PushPull<I, A>

where I: Data, A: Data,

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

The reference type of the data.

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

where PushPull<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, PushPull<I, A>> for PushPullRef<'a, <I as Data>::Ref<'a>, <A as Data>::Ref<'a>>

where I: Data, A: Data,

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

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 PushPull<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 PushPull<I, A>

where I: Eq, A: Eq,

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> Hash for PushPull<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 PushPull<I, A>

where I: PartialEq, A: PartialEq,

fn eq(&self, other: &PushPull<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 PushPull<I, A>

where I: PartialEq, A: PartialEq,