Struct RelaySideOptions 

pub struct RelaySideOptions {
    pub reliable_enabled: bool,
    pub link_local_enabled: bool,
    pub ingress_enabled: bool,
    pub egress_enabled: bool,
    pub header_template_enabled: bool,
    pub max_frame_bytes: usize,
    pub compact_header_target_bytes: usize,
    pub max_side_transport_templates: usize,
    pub omit_unchanged_compact_timestamps: bool,
    pub compact_timestamp_omission_types: CompactTimestampOmissionPolicy,
    pub side_transport_profile: SideTransportProfile,
}

Fields

reliable_enabled: bool

Enables the relay’s per-link reliable transport layer on this side.

When true and the side uses a packed TX handler, reliable schema traffic on this hop gains relay-managed sequence numbers, ACKs, packet requests, and retransmits. Packet-output sides still receive decoded packets rather than packed reliable framing.

link_local_enabled: bool

Marks the side as eligible for link-local-only endpoints and discovery routes.

ingress_enabled: bool

Allows packets received from this side to enter relay processing.

egress_enabled: bool

Allows the relay to transmit packets toward this side.

header_template_enabled: bool

Enables side-local header-template reuse for packed transport.

max_frame_bytes: usize

Maximum number of bytes to emit per packed TX callback.

When non-zero and a packed frame would exceed this size, the relay splits it into ordered side-transport chunks and reassembles them on RX before normal relay processing. This is intended for fixed-size links such as CAN or I2C while keeping the user API packet-oriented.

compact_header_target_bytes: usize

Target total side-transport overhead for compact follow-up frames.

max_side_transport_templates: usize

Maximum side-local header templates retained for TX and RX dictionaries.

omit_unchanged_compact_timestamps: bool

Omits the timestamp field from compact follow-up frames when it is unchanged.

compact_timestamp_omission_types: CompactTimestampOmissionPolicy

Optional per-data-type timestamp omission policy for compact follow-up frames.

side_transport_profile: SideTransportProfile

Declared compact-link profile for stats and future negotiation.

Implementations

impl RelaySideOptions

pub fn with_small_packet_transport(self, max_frame_bytes: usize) -> Self

Convenience preset for bounded packed-side transport.

max_frame_bytes == 0 leaves packed frames unbounded. Values greater than zero enable relay-managed chunking/reassembly on this side.

pub fn with_ipv4_like_compact_header_target(self) -> Self

pub fn with_ipv6_like_compact_header_target(self) -> Self

pub fn with_template_transport(self) -> Self

pub fn with_omitted_unchanged_compact_timestamps(self) -> Self

pub fn with_omitted_unchanged_compact_timestamps_for_type( self, ty: DataType, ) -> Self

pub fn effective_transport_profile(self) -> SideTransportProfile

pub fn link_capabilities(self) -> LinkCapabilities

Trait Implementations

impl Clone for RelaySideOptions

fn clone(&self) -> RelaySideOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RelaySideOptions

impl Debug for RelaySideOptions

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

Formats the value using the given formatter.

impl Default for RelaySideOptions

fn default() -> Self

Returns the “default value” for a type.