Struct PayloadEncoding

pub struct PayloadEncoding { /* private fields */ }

Open identity of the payload representation carried by a native frame.

A payload encoding is identified by up to three components:

• registry_id: a numeric id registered with the uProtocol payload encoding registry. Ids 1..=8 are permanently reserved for the encodings historically expressed by the legacy UPayloadFormat enum (value-compatible with it), 9..=0x7FFF_FFFF for future registered encodings, and 0x8000_0000.. for vendor/private use.
• literal_id: a language-neutral literal identity such as up.stable-container or up.xcdr-v2.
• content_type: an RFC 6838 media type, optionally with parameters, such as application/vnd.uprotocol.xcdr-v2;endianness=little;version=2.

At least one component must be present. Unlike the retired closed UPayloadFormat enum, new encodings can be introduced without touching any SDK enum: register a literal id (and optionally a numeric id), or use a vendor media type.

The projection to and from the legacy enum is explicit and fallible: PayloadEncoding::try_from_legacy_format and PayloadEncoding::to_legacy_format.

Implementations

impl PayloadEncoding

pub const PROTOBUF_WRAPPED_IN_ANY: PayloadEncoding

Protocol Buffers serialized payload wrapped in google.protobuf.Any.

pub const PROTOBUF: PayloadEncoding

Protocol Buffers serialized payload.

pub const JSON: PayloadEncoding

JSON payload.

pub const SOMEIP: PayloadEncoding

SOME/IP serialized payload.

pub const SOMEIP_TLV: PayloadEncoding

SOME/IP TLV serialized payload.

pub const RAW: PayloadEncoding

Raw binary payload.

pub const TEXT: PayloadEncoding

UTF-8 text payload.

pub const SHM: PayloadEncoding

Shared-memory reference payload.

pub const LEGACY_COMPATIBLE: [PayloadEncoding; 8]

All encodings with registry ids permanently reserved for legacy UPayloadFormat compatibility.

pub fn custom( id: impl Into<String>, content_type: impl Into<String>, ) -> Result<Self, UFrameMetadataError>

Creates a validated custom payload encoding from a literal id and a media type.

Errors

Returns an error when id is empty, content_type is empty, or content_type is not a valid media type.

pub fn from_parts( registry_id: Option<u32>, literal_id: Option<String>, content_type: Option<String>, ) -> Result<Self, UFrameMetadataError>

Creates a validated payload encoding from explicit identity components.

Errors

Returns an error when all components are absent, when a present component is empty, or when the content type is not a valid media type.

pub fn registry_id(&self) -> Option<u32>

Returns the registered numeric identity, if present.

pub fn literal_id(&self) -> Option<&str>

Returns the literal identity, if present.

pub fn content_type(&self) -> Option<&str>

Returns the media type, if present.

pub fn custom_identity(&self) -> Option<(&str, &str)>

Returns the custom encoding identity (literal_id, content_type) when both are present.

pub fn is_compatible_with(&self, expected: &Self) -> bool

Returns whether this encoding can be decoded by a codec expecting expected.

pub fn try_from_legacy_format( format: UPayloadFormat, ) -> Result<Self, UFrameMetadataError>

Projects a legacy UPayloadFormat to its reserved registered encoding.

This is a compatibility projection: the returned encoding is the full registered identity (numeric id, literal id, and media type) reserved for the legacy value.

Errors

Returns an error for UPayloadFormat::Unspecified, which is not a concrete payload encoding.

pub fn to_legacy_format(&self) -> Option<UPayloadFormat>

Projects this encoding to the legacy UPayloadFormat, if it has a legacy equivalent.

This is a compatibility projection for UMessage-shaped boundaries. Encodings outside the reserved legacy range return None; callers must treat that as “not representable”, never as Raw.

pub fn describe(&self) -> String

Returns a diagnostic identity string for error messages.

Trait Implementations

impl Clone for PayloadEncoding

fn clone(&self) -> PayloadEncoding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadEncoding

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

Formats the value using the given formatter.

impl Hash for PayloadEncoding

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 PayloadEncoding

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

impl StructuralPartialEq for PayloadEncoding