Struct RawPayload 

pub struct RawPayload { /* private fields */ }

A concrete PayloadWireFormat backed by heap-allocated storage.

SD messages are stored as a VecSdHeader; all other messages are stored as opaque bytes. This type is suitable as the payload parameter for Message<RawPayload> in FFI bindings or any context where a fixed, non-generic payload type is needed.

Implementations

impl RawPayload

pub fn raw_bytes(&self) -> Option<&[u8]>

Returns the raw payload bytes for non-SD messages, or None for SD messages.

Trait Implementations

impl Clone for RawPayload

fn clone(&self) -> RawPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawPayload

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

Formats the value using the given formatter.

impl Eq for RawPayload

impl PartialEq for RawPayload

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

type SdHeader = VecSdHeader

The SD header type used by this payload implementation.

fn message_id(&self) -> MessageId

Get the Message ID for the payload

fn as_sd_header(&self) -> Option<&VecSdHeader>

Get the payload as a service discovery header

fn from_payload_bytes( message_id: MessageId, payload: &[u8], ) -> Result<Self, Error>

Construct a payload from raw bytes and a message ID.

fn new_sd_payload(header: &VecSdHeader) -> Self

Create a PayloadWireFormat from a service discovery Header

fn sd_flags(&self) -> Option<Flags>

Return the SD flags if this payload is a service discovery message.

fn required_size(&self) -> usize

Number of bytes required to write the payload

fn encode<T: Write>(&self, writer: &mut T) -> Result<usize, Error>

Serialize the payload to a Writer

fn new_subscription_sd_header( service_id: u16, instance_id: u16, major_version: u8, ttl: u32, event_group_id: u16, client_ip: Ipv4Addr, protocol: TransportProtocol, client_port: u16, reboot_flag: RebootFlag, ) -> VecSdHeader

Construct an SD header for subscribing to an event group.

fn set_reboot_flag(header: &mut VecSdHeader, reboot: RebootFlag)

Override the reboot flag on an SD header in-place.

fn for_each_offered_endpoint<F>(&self, f: F)

where F: FnMut(OfferedEndpoint),

Visit each offered / stopped service endpoint in this SD payload with f.

fn for_each_service_instance<F>(&self, f: F)

where F: FnMut(u16, u16),

Visit (service_id, instance_id) for every SD entry in this payload, regardless of entry type, with f.

fn offered_endpoints(&self) -> Vec<OfferedEndpoint>

Convenience accessor returning all offered endpoints as a heap Vec. Wraps Self::for_each_offered_endpoint so std users get the original ergonomic shape; bare-metal users use the visitor directly. Gated on feature = "std".

fn service_instances(&self) -> Vec<(u16, u16)>

Convenience accessor returning all (service_id, instance_id) pairs as a heap Vec. Wraps Self::for_each_service_instance for std users. Gated on feature = "std".

impl StructuralPartialEq for RawPayload