Struct K2Proto

pub struct K2Proto {
    pub ty: i32,
    pub data: Bytes,
    pub space: Option<Bytes>,
    pub module: Option<String>,
}

A Kitsune2 wire protocol message.

This is the top-level encoding that will be transferred between Kitsune2 peers. Most communications between peers to make Kitsune2 actually function will be encoded separately inside the payload of TY_MODULE type messages.

Fields

ty: i32

The type of this message.

data: Bytes

The payload or content of this message.

space: Option<Bytes>

If the Ty requires that a space be specified, this is it.

Kitsune is divided up into multiple dht “spaces” and peers join and communicate over these spaces. These bytes identify the space within which this message is communicating.

module: Option<String>

If the Ty requires a module impl be specified, this is it.

Modules include specific sub-protocols to communicate with each other, so those messages must be routed to the correct module.

This string is the module routing info. E.g. “gossip”, “fetch”, “sharding”.

Implementations

impl K2Proto

pub fn ty(&self) -> K2WireType

Returns the enum value of ty, or the default if the field is set to an invalid enum value.

pub fn set_ty(&mut self, value: K2WireType)

Sets ty to the provided enum value.

pub fn space(&self) -> &[u8]

Returns the value of space, or the default value if space is unset.

pub fn module(&self) -> &str

Returns the value of module, or the default value if module is unset.

impl K2Proto

pub fn decode(bytes: &[u8]) -> K2Result<Self>

Decode this message from a byte array.

pub fn encode(&self) -> K2Result<Bytes>

Encode this message as a bytes::Bytes buffer.

Trait Implementations

impl Clone for K2Proto

fn clone(&self) -> K2Proto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for K2Proto

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

Formats the value using the given formatter.

impl Default for K2Proto

fn default() -> Self

Returns the “default value” for a type.

impl Message for K2Proto

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for K2Proto

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