Struct RecordMetadata

pub struct RecordMetadata<'a> {
    record: &'a Record,
    shard_id: String,
    attempt_number: u32,
}

Metadata associated with a Kinesis record during processing

This struct provides access to record metadata through reference-based accessors, avoiding unnecessary data copying while maintaining access to processing context such as shard ID and attempt count.

Examples

use go_zoom_kinesis::processor::RecordMetadata;
use aws_sdk_kinesis::types::Record;

fn process_with_metadata(metadata: &RecordMetadata) {
    println!("Processing record {} from shard {}",
        metadata.sequence_number(),
        metadata.shard_id()
    );

    if metadata.attempt_number() > 1 {
        println!("Retry attempt {}", metadata.attempt_number());
    }

    if let Some(timestamp) = metadata.approximate_arrival_timestamp() {
        println!("Record arrived at: {}", timestamp);
    }
}

Fields

record: &'a Record

Reference to the underlying Kinesis record

shard_id: String

ID of the shard this record came from

attempt_number: u32

Number of processing attempts for this record (starts at 1)

Implementations

impl<'a> RecordMetadata<'a>

pub fn new(record: &'a Record, shard_id: String, attempt_number: u32) -> Self

Creates a new metadata instance for a record

Arguments

• record - Reference to the Kinesis record
• shard_id - ID of the shard this record came from
• attempt_number - Current processing attempt number (starts at 1)

pub fn sequence_number(&self) -> &str

Gets the sequence number of the record

This is a unique identifier for the record within its shard.

pub fn approximate_arrival_timestamp(&self) -> Option<DateTime<Utc>>

Gets the approximate time when the record was inserted into the stream

Returns None if the timestamp is not available or cannot be converted to the chrono timestamp format.

pub fn partition_key(&self) -> &str

Gets the partition key of the record

The partition key is used to determine which shard in the stream the record belongs to.

pub fn shard_id(&self) -> &str

Gets the ID of the shard this record came from

pub fn attempt_number(&self) -> u32

Gets the current processing attempt number

This starts at 1 for the first attempt and increments for each retry.

Trait Implementations

impl<'a> Debug for RecordMetadata<'a>

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

Formats the value using the given formatter.