Struct StreamingReceipt 

pub struct StreamingReceipt { /* private fields */ }

Versioned, deterministic accounting receipt for one streaming execution.

Implementations

impl StreamingReceipt

pub fn new(source_id: impl Into<String>) -> RecordsResult<Self>

Creates an empty v1 receipt for a non-empty source identifier.

pub fn record_input_chunk( &mut self, points: u64, bytes: u64, ) -> RecordsResult<()>

Records one input chunk using checked counters.

pub fn record_output_chunk( &mut self, points: u64, bytes: u64, ) -> RecordsResult<()>

Records one output chunk using checked counters.

pub fn record_spill(&mut self, bytes: u64) -> RecordsResult<()>

Records bytes written to explicit temporary spill storage.

pub fn capture_memory(&mut self, tracker: &MemoryTracker)

Captures the peak from an exact memory tracker.

pub fn record_phase( &mut self, name: impl Into<String>, elapsed_ns: u64, allocated_bytes: u64, ) -> RecordsResult<()>

Inserts or replaces one named phase receipt.

pub fn record_transfer( &mut self, name: impl Into<String>, direction: StreamingTransferDirection, bytes: u64, ) -> RecordsResult<()>

Appends one named explicit transfer.

pub fn validate(&self) -> RecordsResult<()>

Validates schema identity and all name constraints.

pub fn to_json(&self) -> RecordsResult<String>

Serializes this receipt using the versioned JSON contract.

pub fn from_json(json: &str) -> RecordsResult<Self>

Parses and validates a versioned JSON receipt.

pub const fn version(&self) -> u32

Returns the receipt schema version.

pub fn source_id(&self) -> &str

Returns the stable source identifier.

pub const fn input_points(&self) -> u64

Returns input points observed so far.

pub const fn output_points(&self) -> u64

Returns output points observed so far.

pub const fn chunks_read(&self) -> u64

Returns input chunks observed so far.

pub const fn chunks_written(&self) -> u64

Returns output chunks observed so far.

pub const fn bytes_read(&self) -> u64

Returns input bytes observed so far.

pub const fn bytes_written(&self) -> u64

Returns output bytes observed so far.

pub const fn peak_tracked_bytes(&self) -> u64

Returns the maximum explicitly tracked live memory.

pub const fn spilled_bytes(&self) -> u64

Returns bytes written to temporary spill storage.

pub const fn phases(&self) -> &BTreeMap<String, StreamingPhaseReceipt>

Returns deterministic phase receipts ordered by name.

pub fn transfers(&self) -> &[StreamingTransferReceipt]

Returns explicit transfers in execution order.

Trait Implementations

impl Clone for StreamingReceipt

fn clone(&self) -> StreamingReceipt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingReceipt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamingReceipt

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StreamingReceipt

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StreamingReceipt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StreamingReceipt

impl StructuralPartialEq for StreamingReceipt