Struct UFrameMetadataBuilder

pub struct UFrameMetadataBuilder { /* private fields */ }

Builder for native frame metadata.

Obtained from UFrameMetadata::publish, UFrameMetadata::notification, UFrameMetadata::request, or UFrameMetadata::response. Native selected-wire code should construct metadata through this builder instead of going through UMessageBuilder and projecting.

Implementations

impl UFrameMetadataBuilder

pub fn with_id(self, id: UUID) -> Self

Sets an explicit frame id instead of a generated one.

pub fn with_priority(self, priority: FramePriority) -> Self

Sets the frame priority.

pub fn with_ttl(self, ttl: Duration) -> Self

Sets the time-to-live.

pub fn with_comm_status(self, comm_status: UCode) -> Self

Sets the communication status.

pub fn with_permission_level(self, permission_level: u32) -> Self

Sets the permission level.

pub fn with_token(self, token: impl Into<String>) -> Self

Sets the access token.

pub fn with_traceparent(self, traceparent: impl Into<String>) -> Self

Sets the W3C traceparent.

pub fn with_payload_encoding(self, payload_encoding: PayloadEncoding) -> Self

Sets the payload encoding of the frame’s payload bytes.

pub fn build(self) -> Result<UFrameMetadata, UFrameMetadataError>

Builds and validates the frame metadata.

A fresh UUIDv7 frame id is generated unless one was supplied via Self::with_id.

Errors

Returns an error if the metadata violates the rules of its frame message kind.

Trait Implementations

impl Clone for UFrameMetadataBuilder

fn clone(&self) -> UFrameMetadataBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UFrameMetadataBuilder

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

Formats the value using the given formatter.