Enum WellKnownFrameEncoding 

#[repr(i32)]
pub enum WellKnownFrameEncoding {
    Unspecified = 0,
    Ros1 = 1,
    Cdr = 2,
    Protobuf = 3,
    Flatbuffer = 4,
    Cbor = 5,
    Msgpack = 6,
    Json = 7,
}

Well-known encoding for frame payloads.

Mirrors the well-known message encodings from the MCAP spec: https://mcap.dev/spec/registry#message-encodings

Variants

Unspecified = 0

Ros1 = 1

ROS 1: must be described by ROS1_MSG schema encoding.

Cdr = 2

CDR: must be described by ROS2_MSG, ROS2_IDL, or OMG_IDL schema encoding.

Protobuf = 3

Protocol Buffer: must be described by PROTOBUF schema encoding.

Flatbuffer = 4

FlatBuffer: must be described by FLATBUFFER schema encoding.

Cbor = 5

CBOR: self-describing.

Msgpack = 6

MessagePack: self-describing.

Json = 7

JSON: self-describing or described by JSON_SCHEMA schema encoding.

Implementations

impl WellKnownFrameEncoding

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of WellKnownFrameEncoding.

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

👎Deprecated:

Use the TryFrom<i32> implementation instead

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

impl WellKnownFrameEncoding

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 WellKnownFrameEncoding

fn clone(&self) -> WellKnownFrameEncoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WellKnownFrameEncoding

impl Debug for WellKnownFrameEncoding

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

Formats the value using the given formatter.

impl Default for WellKnownFrameEncoding

fn default() -> WellKnownFrameEncoding

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WellKnownFrameEncoding

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WellKnownFrameEncoding

impl From<WellKnownFrameEncoding> for i32

fn from(value: WellKnownFrameEncoding) -> i32

Converts to this type from the input type.

impl Hash for WellKnownFrameEncoding

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 WellKnownFrameEncoding

fn cmp(&self, other: &WellKnownFrameEncoding) -> 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 WellKnownFrameEncoding

fn eq(&self, other: &WellKnownFrameEncoding) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WellKnownFrameEncoding

fn partial_cmp(&self, other: &WellKnownFrameEncoding) -> 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 Serialize for WellKnownFrameEncoding

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WellKnownFrameEncoding

impl TryFrom<i32> for WellKnownFrameEncoding

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<WellKnownFrameEncoding, DecodeError>

Performs the conversion.