Enum BusFrameV1 

pub enum BusFrameV1 {
    Hello {
        instance_id: String,
        agents: Vec<BusAgentV1>,
        cursors: BTreeMap<String, u64>,
    },
    Presence {
        agent_id: String,
        state: PresenceState,
        profile: Option<PresenceProfileV1>,
    },
    Publish {
        client_msg_id: String,
        channel: String,
        to: Option<String>,
        from: String,
        kind: String,
        priority: BusPriority,
        privacy: BusPrivacy,
        body: Value,
    },
    Ack {
        channel: String,
        seq: u64,
    },
    Published {
        client_msg_id: String,
        channel: String,
        seq: u64,
        server_time: UtcTimestamp,
    },
    Deliver {
        seq: u64,
        channel: String,
        from: String,
        to: Option<String>,
        kind: String,
        priority: BusPriority,
        privacy: BusPrivacy,
        body: Value,
        server_time: UtcTimestamp,
    },
    PresenceUpdate {
        agent_id: String,
        instance_id: String,
        role: String,
        vault_id: String,
        state: PresenceState,
        server_time: UtcTimestamp,
        profile_id: Option<String>,
        profile: Option<PresenceProfileV1>,
    },
    Control {
        control_id: String,
        target_agent: Option<String>,
        target_ref: Option<String>,
        action: ControlAction,
        reason: String,
        issued_by: String,
        seq: u64,
        server_time: UtcTimestamp,
    },
    HandoffOffer {
        handoff_id: String,
        channel: String,
        from: String,
        to: String,
        bundle_ref: String,
        deadline: UtcTimestamp,
    },
    HandoffAck {
        handoff_id: String,
        by: String,
    },
    HandoffReject {
        handoff_id: String,
        by: String,
        reason: String,
    },
    Message(AgentMessageV1),
    MessageStored(MessageStoredV1),
    MessageDeliver(MessageDeliveryV1),
    MessageReceipt(MessageReceiptV1),
    MessageStatus(MessageStatusV1),
    TaskEvent(TaskEventV1),
    KnowledgeEvent(KnowledgeEventV1),
    Ping {
        nonce: u64,
    },
    Pong {
        nonce: u64,
    },
    Error {
        client_msg_id: Option<String>,
        error: HiveErrorDetailV1,
    },
    Unknown,
}

One WebSocket frame (also the items of BusPollV1).

Variants

Hello

client → service, first frame.

Fields

instance_id: String

agents: Vec<BusAgentV1>

cursors: BTreeMap<String, u64>

Last seq seen per channel; the service replays newer events.

Presence

client → service.

Fields

agent_id: String

state: PresenceState

profile: Option<PresenceProfileV1>

1.9 (section 5): the agent’s self-reported profile.

Publish

client → service.

Fields

client_msg_id: String

Client-chosen ULID; republishing the same id is a no-op.

channel: String

to: Option<String>

from: String

kind: String

priority: BusPriority

privacy: BusPrivacy

body: Value

Ack

client → service: everything up to seq on channel is processed.

Fields

channel: String

seq: u64

Published

service → client: a publish was stored.

Fields

client_msg_id: String

channel: String

seq: u64

server_time: UtcTimestamp

Deliver

service → client.

Fields

seq: u64

channel: String

from: String

to: Option<String>

kind: String

priority: BusPriority

privacy: BusPrivacy

body: Value

server_time: UtcTimestamp

PresenceUpdate

service → client.

Fields

agent_id: String

instance_id: String

role: String

vault_id: String

state: PresenceState

server_time: UtcTimestamp

profile_id: Option<String>

1.9 (section 5): the agent’s profile id.

profile: Option<PresenceProfileV1>

1.9 (section 5): what the agent announced.

Control

service → client.

Fields

control_id: String

target_agent: Option<String>

Absent: every agent of the instance.

target_ref: Option<String>

Lease or handoff id for veto.

action: ControlAction

reason: String

issued_by: String

seq: u64

server_time: UtcTimestamp

HandoffOffer

either direction.

Fields

handoff_id: String

channel: String

from: String

to: String

bundle_ref: String

Reference to a context bundle the receiver fetches; never the content.

deadline: UtcTimestamp

HandoffAck

receiver → service → offerer.

Fields

handoff_id: String

by: String

HandoffReject

receiver → service → offerer.

Fields

handoff_id: String

by: String

reason: String

Message(AgentMessageV1)

1.9 (section 2), client → service: an agent message.

MessageStored(MessageStoredV1)

1.9, service → sender: the message was stored (its gid).

MessageDeliver(MessageDeliveryV1)

1.9, service → client.

MessageReceipt(MessageReceiptV1)

1.9, client → service: delivered or read.

MessageStatus(MessageStatusV1)

1.9, service → sender.

TaskEvent(TaskEventV1)

1.9, service → client: a task changed (section 1).

KnowledgeEvent(KnowledgeEventV1)

1.9, service → client: a knowledge revision was released, quarantined or rolled back (section 3).

Ping

Fields

nonce: u64

Pong

Fields

nonce: u64

Error

service → client: a frame was refused; the socket stays open.

Fields

client_msg_id: Option<String>

error: HiveErrorDetailV1

Unknown

A frame type this engine does not know; ignored.

Implementations

impl BusFrameV1

pub fn validate(&self) -> Result<(), ValidationError>

Checks the service applies to client frames (and the engine before sending).

Trait Implementations

impl Clone for BusFrameV1

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BusFrameV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BusFrameV1

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BusFrameV1

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BusFrameV1

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 BusFrameV1