Preview of the proposed up-rust native-frame-model branch (up-rust b6b99c6d, up-spec f0e9b17) — not released documentation. branch · write-up

Trait PayloadFormat

Source
pub trait PayloadFormat {
    // Required methods
    fn name() -> &'static str;
    fn encoding() -> PayloadEncoding;
}
Expand description

Compile-time identity for an application payload codec.

use up_rust::{payload::codec::PayloadFormat, PayloadEncoding, UPayloadFormat};

struct JsonTelemetry;

impl PayloadFormat for JsonTelemetry {
    fn name() -> &'static str {
        "json-telemetry-v1"
    }

    fn encoding() -> PayloadEncoding {
        PayloadEncoding::JSON
    }
}

Required Methods§

Source

fn name() -> &'static str

Stable codec name for logs, diagnostics, and configuration.

Source

fn encoding() -> PayloadEncoding

Payload encoding metadata written into frames that use this codec.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§