Enum K2WireType

#[repr(i32)]
pub enum K2WireType {
    Unspecified = 0,
    Preflight = 1,
    Notify = 2,
    Module = 3,
    Disconnect = 15,
}

Enumeration of the types of messages that can be sent between peers.

We are using this enum field to distinguish between top-level messages, rather than protobuf’s oneof because of the downsides of upgrading oneofs.

Variants

Unspecified = 0

The “UNSPECIFIED” type for future message types.

In general, peers should ignore unspecified messages, but should still count them toward any ratelimiting metrics.

Preflight = 1

This message is preflight data.

The implementor is responsible for encoding any module-specific requirements within the data payload of this message type. For example, if peers are required to include the “dht_v1” module to communicate with each other, they should reject preflight to peers that do not include that module.

Notify = 2

This is a notification or fire-and-forget message from a peer.

This type requires that a “space” be specified.

Module = 3

This is a module communication.

Most of Kitsune2’s communications will likely proceed between Kitsune2’s modules.

This type requires that a “space” be specified. This type requires that a “module” be specified.

Disconnect = 15

This message indicates a general disconnect, with the reason or context specified in the data payload.

We may add additional specific disconnect codes in the future.

Implementations

impl K2WireType

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of K2WireType.

pub fn from_i32(value: i32) -> Option<K2WireType>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a K2WireType, or None if value is not a valid variant.

impl K2WireType

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for K2WireType

fn clone(&self) -> K2WireType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for K2WireType

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

Formats the value using the given formatter.

impl Default for K2WireType

fn default() -> K2WireType

Returns the “default value” for a type.

impl From<K2WireType> for i32

fn from(value: K2WireType) -> i32

Converts to this type from the input type.

impl Hash for K2WireType

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

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 Ord for K2WireType

fn cmp(&self, other: &K2WireType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for K2WireType

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

fn partial_cmp(&self, other: &K2WireType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for K2WireType

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<K2WireType, UnknownEnumValue>

Performs the conversion.

impl Copy for K2WireType

impl Eq for K2WireType

impl StructuralPartialEq for K2WireType