Enum UPayloadFormat

pub enum UPayloadFormat {
    UPAYLOAD_FORMAT_UNSPECIFIED = 0,
    UPAYLOAD_FORMAT_PROTOBUF_WRAPPED_IN_ANY = 1,
    UPAYLOAD_FORMAT_PROTOBUF = 2,
    UPAYLOAD_FORMAT_JSON = 3,
    UPAYLOAD_FORMAT_SOMEIP = 4,
    UPAYLOAD_FORMAT_SOMEIP_TLV = 5,
    UPAYLOAD_FORMAT_RAW = 6,
    UPAYLOAD_FORMAT_TEXT = 7,
    UPAYLOAD_FORMAT_SHM = 8,
}

Variants

UPAYLOAD_FORMAT_UNSPECIFIED = 0

UPAYLOAD_FORMAT_PROTOBUF_WRAPPED_IN_ANY = 1

UPAYLOAD_FORMAT_PROTOBUF = 2

UPAYLOAD_FORMAT_JSON = 3

UPAYLOAD_FORMAT_SOMEIP = 4

UPAYLOAD_FORMAT_SOMEIP_TLV = 5

UPAYLOAD_FORMAT_RAW = 6

UPAYLOAD_FORMAT_TEXT = 7

UPAYLOAD_FORMAT_SHM = 8

Implementations

impl UPayloadFormat

pub fn from_media_type(media_type_string: &str) -> Result<Self, UPayloadError>

Gets the payload format that corresponds to a given media type.

Errors

Returns an error if the given string is not a valid media type string or is unsupported by uProtocol.

Examples

use up_rust::UPayloadFormat;

let parse_attempt = UPayloadFormat::from_media_type("application/json; charset=utf-8");
assert!(parse_attempt.is_ok());
assert_eq!(parse_attempt.unwrap(), UPayloadFormat::UPAYLOAD_FORMAT_JSON);

let parse_attempt = UPayloadFormat::from_media_type("application/unsupported");
assert!(parse_attempt.is_err());

pub fn to_media_type(self) -> Option<String>

Gets the media type corresponding to this payload format.

Returns

None if the payload format is UPayloadFormat::UPAYLOAD_FORMAT_UNSPECIFIED.

Examples

use up_rust::UPayloadFormat;

assert_eq!(UPayloadFormat::UPAYLOAD_FORMAT_JSON.to_media_type().unwrap(), "application/json");
assert!(UPayloadFormat::UPAYLOAD_FORMAT_UNSPECIFIED.to_media_type().is_none());

Trait Implementations

impl Clone for UPayloadFormat

fn clone(&self) -> UPayloadFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UPayloadFormat

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

Formats the value using the given formatter.

impl Default for UPayloadFormat

fn default() -> Self

Returns the “default value” for a type.

impl Enum for UPayloadFormat

const NAME: &'static str = "UPayloadFormat"

Enum name as specified in .proto file.

const VALUES: &'static [UPayloadFormat]

All enum values for enum type.

fn value(&self) -> i32

Get enum i32 value.

fn from_i32(value: i32) -> Option<UPayloadFormat>

Try to create an enum from i32 value. Return None if value is unknown.

fn from_str(str: &str) -> Option<UPayloadFormat>

Try to create an enum from &str value. Return None if str is unknown.

impl EnumFull for UPayloadFormat

fn enum_descriptor() -> EnumDescriptor

Get enum descriptor by type.

fn descriptor(&self) -> EnumValueDescriptor

Get enum value descriptor.

impl Hash for UPayloadFormat

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 PartialEq for UPayloadFormat

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

Tests for self and other values to be equal, and is used by ==.

const 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 Copy for UPayloadFormat

impl Eq for UPayloadFormat

impl StructuralPartialEq for UPayloadFormat