Struct CollaborationEvent 

pub struct CollaborationEvent {
    pub correlation_id: String,
    pub topic: String,
    pub producer: String,
    pub consumer: Option<String>,
    pub kind: CollaborationEventKind,
    pub payload: Value,
    pub timestamp: u64,
}

Available on crate feature code only.

A typed collaboration event for cross-agent coordination in a shared workspace.

Collaboration events carry correlation IDs, topic names, producer/consumer identities, and structured payloads. They support the wait/resume pattern: an agent can publish a CollaborationEventKind::NeedWork event and resume only when a matching CollaborationEventKind::WorkPublished event arrives.

Example

use adk_code::{CollaborationEvent, CollaborationEventKind};

let event = CollaborationEvent::new(
    "corr-42",
    "api-routes",
    "backend_engineer",
    CollaborationEventKind::WorkPublished,
)
.consumer("frontend_engineer")
.payload(serde_json::json!({ "routes": ["/api/users"] }));

assert_eq!(event.correlation_id, "corr-42");
assert_eq!(event.consumer.as_deref(), Some("frontend_engineer"));

Fields

correlation_id: String

Correlation ID linking related events (e.g., request and response).

topic: String

Topic or work item name this event relates to.

producer: String

Identity of the agent that produced this event.

consumer: Option<String>

Identity of the intended consumer, if targeted.

kind: CollaborationEventKind

The kind of collaboration event.

payload: Value

Structured payload carrying event-specific data.

timestamp: u64

Timestamp when the event was created (Unix epoch milliseconds).

Implementations

impl CollaborationEvent

pub fn new( correlation_id: impl Into<String>, topic: impl Into<String>, producer: impl Into<String>, kind: CollaborationEventKind, ) -> CollaborationEvent

Create a new collaboration event with the given correlation ID, topic, producer, and kind.

The payload defaults to null, consumer defaults to None, and timestamp defaults to 0 (callers should set it via Self::timestamp).

Example

use adk_code::{CollaborationEvent, CollaborationEventKind};

let event = CollaborationEvent::new(
    "req-1",
    "database-schema",
    "coordinator",
    CollaborationEventKind::NeedWork,
);
assert_eq!(event.kind, CollaborationEventKind::NeedWork);
assert_eq!(event.producer, "coordinator");

pub fn consumer(self, consumer: impl Into<String>) -> CollaborationEvent

Set the intended consumer for this event.

pub fn payload(self, payload: Value) -> CollaborationEvent

Set the structured payload for this event.

pub fn timestamp(self, ts: u64) -> CollaborationEvent

Set the timestamp (Unix epoch milliseconds).

Trait Implementations

impl Clone for CollaborationEvent

fn clone(&self) -> CollaborationEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollaborationEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollaborationEvent

fn deserialize<__D>( __deserializer: __D, ) -> Result<CollaborationEvent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CollaborationEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.