Struct RecordEvent 

pub struct RecordEvent {
    pub live: bool,
    pub rev: CompactString,
    pub did: Box<str>,
    pub collection: Box<str>,
    pub rkey: CompactString,
    pub action: RecordAction,
    pub cid: Option<CompactString>,
    pub record: Option<Value>,
}

A repository record event from TAP.

Contains information about a record change in a user’s repository, including the action taken and the record data (for creates/updates).

Fields

live: bool

True if from live firehose, false if from backfill/resync.

During initial sync or recovery, TAP delivers historical events with live: false. Once caught up, live events have live: true.

rev: CompactString

Repository revision identifier.

Typically 13 characters, stored inline via CompactString SSO.

did: Box<str>

Actor DID (e.g., “did:plc:xyz123”).

collection: Box<str>

Collection NSID (e.g., “app.bsky.feed.post”).

rkey: CompactString

Record key within the collection.

Typically a TID (13 characters), stored inline via CompactString SSO.

action: RecordAction

The action performed on the record.

cid: Option<CompactString>

Content identifier (CID) of the record.

Present for create and update actions, absent for delete.

record: Option<Value>

Record data as JSON value.

Present for create and update actions, absent for delete. Use parse_record to deserialize on demand.

Implementations

impl RecordEvent

pub fn parse_record<T: DeserializeOwned>(&self) -> Result<T, Error>

Parse the record payload into a typed structure.

This method deserializes the raw JSON on demand, avoiding unnecessary allocations when the record data isn’t needed.

Errors

Returns an error if the record is absent (delete events) or if deserialization fails.

Example

use serde::Deserialize;

#[derive(Deserialize)]
struct Post {
    text: String,
    #[serde(rename = "createdAt")]
    created_at: String,
}

let post: Post = record_event.parse_record()?;
println!("Post text: {}", post.text);

pub fn record_value(&self) -> Option<&Value>

Returns the record as a JSON Value reference, if present.

pub fn is_delete(&self) -> bool

Returns true if this is a delete event.

pub fn at_uri(&self) -> String

Returns the AT-URI for this record.

Format: at://{did}/{collection}/{rkey}

Trait Implementations

impl Clone for RecordEvent

fn clone(&self) -> RecordEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RecordEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RecordEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.