Struct RegisterPayload 

#[non_exhaustive]
pub struct RegisterPayload {
    pub capabilities: BTreeSet<Capability>,
    pub runtime_instance_id: Option<Uuid>,
}

Payload sent by every service on connect to declare its capabilities.

Sent from on_connected before any other messages. The controller uses this as the authoritative source for capability detection on the current session and persists the capability set to the DB.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

capabilities: BTreeSet<Capability>

Capabilities declared by this service instance.

runtime_instance_id: Option<Uuid>

Runtime instance identity for restart-vs-reconnect detection.

Optional for mixed-version compatibility: legacy services omit this field and are treated as service-scoped (not instance-scoped).

Implementations

impl RegisterPayload

pub fn new(capabilities: impl IntoIterator<Item = Capability>) -> Self

Create a new RegisterPayload with the given capability set.

Example

use std::collections::BTreeSet;
use uptrakit_wire::{Capability, RegisterPayload};

let payload = RegisterPayload::new([Capability::SoftwareDiscovery, Capability::UpdateHooks]);
assert!(payload.capabilities.contains(&Capability::SoftwareDiscovery));

pub fn with_runtime_instance_id(self, runtime_instance_id: Uuid) -> Self

Set a runtime instance id on this register payload.

Trait Implementations

impl Clone for RegisterPayload

fn clone(&self) -> RegisterPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterPayload

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

Formats the value using the given formatter.

impl Default for RegisterPayload

fn default() -> RegisterPayload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RegisterPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RegisterPayload

impl PartialEq for RegisterPayload

fn eq(&self, other: &RegisterPayload) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RegisterPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RegisterPayload

impl WireValidate for RegisterPayload

fn wire_validate(&self) -> Result<(), WireValidationError>

Validate that all fields are within wire protocol size limits.