README

mokomoking2501/lockwire/trace does not have a README file

#
TraceArtifactError

pub(all) suberror TraceArtifactError {
InvalidArtifact(String)
MissingField(String)
InvalidField(String, String)
} derive(
Debug
)

#
BenchmarkMetric

pub(all) struct BenchmarkMetric {
name : String
status : BenchmarkMetricStatus
value : Int64?
unit : String
note : String
} derive(Eq,
Debug
)

#
BenchmarkMetric::estimated

fn BenchmarkMetric::estimated(name~ : String, value~ : Int64, unit~ : String, note~ : String) -> BenchmarkMetric

#
BenchmarkMetric::make

fn BenchmarkMetric::make(name~ : String, status~ : BenchmarkMetricStatus, value~ : Int64?, unit~ : String, note~ : String) -> BenchmarkMetric

#
BenchmarkMetric::measured

fn BenchmarkMetric::measured(name~ : String, value~ : Int64, unit~ : String, note~ : String) -> BenchmarkMetric

#
BenchmarkMetric::missing

fn BenchmarkMetric::missing(name~ : String, unit~ : String, note~ : String) -> BenchmarkMetric

#
BenchmarkMetric::to_text

fn BenchmarkMetric::to_text(self : BenchmarkMetric) -> String

#
BenchmarkMetric::unsupported

fn BenchmarkMetric::unsupported(name~ : String, unit~ : String, note~ : String) -> BenchmarkMetric

#
BenchmarkMetricStatus

pub(all) enum BenchmarkMetricStatus {
Measured
Estimated
Unsupported
Missing
} derive(Eq,
Debug
)

#
BenchmarkMetricStatus::label

fn BenchmarkMetricStatus::label(self : BenchmarkMetricStatus) -> String

#
Recording

pub struct Recording {
// private fields
} derive(
Debug
)

#
Recording::digest

#
Recording::get_log

fn Recording::get_log(self : Recording) -> TraceLog

#
Recording::new

fn Recording::new() -> Recording

#
Recording::record

fn Recording::record(self : Recording, event : TraceEvent) -> Unit

#
Recording::record_rx

fn Recording::record_rx(self : Recording, ev :
RxEvent
, seed~ : Int, rng_step~ : Int, clock_domain~ : String, node_id~ : String, medium_id~ : String, backend~ :
BackendProfile
) -> TraceEvent

#
Recording::record_tx

fn Recording::record_tx(self : Recording, ev :
TxEvent
, seed~ : Int, rng_step~ : Int, clock_domain~ : String, node_id~ : String, medium_id~ : String, backend~ :
BackendProfile
) -> TraceEvent

#
Replay

pub struct Replay {
// private fields
} derive(
Debug
)

#
Replay::digest

#
Replay::from_log

fn Replay::from_log(log : TraceLog) -> Replay

#
Replay::is_exhausted

fn Replay::is_exhausted(self : Replay) -> Bool

#
Replay::next_event

fn Replay::next_event(self : Replay) -> TraceEvent?

#
Replay::peek

fn Replay::peek(self : Replay) -> TraceEvent?

#
Replay::remaining

fn Replay::remaining(self : Replay) -> Int

#
RuntimeBenchmarkReport

pub(all) struct RuntimeBenchmarkReport {
scenario : String
seed : Int
backend :
BackendProfile

digest :
SimDigest

metrics : Array[BenchmarkMetric]
hard_realtime_claim : Bool
live_io_evidence : Bool
} derive(Eq,
Debug
)

#
RuntimeBenchmarkReport::make

fn RuntimeBenchmarkReport::make(scenario~ : String, seed~ : Int, backend~ :
BackendProfile
, digest~ :
SimDigest
, metrics~ : Array[BenchmarkMetric], hard_realtime_claim~ : Bool, live_io_evidence~ : Bool) -> RuntimeBenchmarkReport

#
RuntimeBenchmarkReport::metric_status

fn RuntimeBenchmarkReport::metric_status(self : RuntimeBenchmarkReport, name : String) -> BenchmarkMetricStatus?

#
RuntimeBenchmarkReport::metric_value

fn RuntimeBenchmarkReport::metric_value(self : RuntimeBenchmarkReport, name : String) -> Int64?

#
RuntimeBenchmarkReport::missing_count

fn RuntimeBenchmarkReport::missing_count(self : RuntimeBenchmarkReport) -> Int

#
RuntimeBenchmarkReport::passes_offline_boundary

fn RuntimeBenchmarkReport::passes_offline_boundary(self : RuntimeBenchmarkReport) -> Bool

#
RuntimeBenchmarkReport::to_text

fn RuntimeBenchmarkReport::to_text(self : RuntimeBenchmarkReport) -> String

#
RuntimeBenchmarkReport::unsupported_count

fn RuntimeBenchmarkReport::unsupported_count(self : RuntimeBenchmarkReport) -> Int

#
TraceArtifact

pub(all) struct TraceArtifact {
format : TraceArtifactFormat
sidecar : TraceArtifactSidecar
trace_text : String
} derive(Eq,
Debug
)

#
TraceArtifact::from_log

fn TraceArtifact::from_log(log : TraceLog, seed~ : Int) -> TraceArtifact

#
TraceArtifact::import_log

fn TraceArtifact::import_log(self : TraceArtifact) -> TraceLog raise TraceArtifactError

#
TraceArtifact::replay_digest

#
TraceArtifact::to_pcapng

fn TraceArtifact::to_pcapng(self : TraceArtifact) -> Bytes raise TraceArtifactError

#
TraceArtifact::to_text

fn TraceArtifact::to_text(self : TraceArtifact) -> String

#
TraceArtifactFormat

pub(all) enum TraceArtifactFormat {
IsoTraceTextV1
} derive(Eq,
Debug
)

#
TraceArtifactFormat::label

fn TraceArtifactFormat::label(self : TraceArtifactFormat) -> String

#
TraceArtifactSidecar

pub(all) struct TraceArtifactSidecar {
schema : String
pcapng_route : String
pcapng_blocker : String?
seed : Int
event_count : Int
rng_steps : Int
digest_state : Int64
portable_digest_state : Int64
clock_domains : Array[String]
backend_labels : Array[String]
} derive(Eq,
Debug
)

#
TraceDirection

pub(all) enum TraceDirection {
Tx
Rx
Fault
Tick
Charge
Process
Resource
Probe
Meta
} derive(Eq,
Debug
)

#
TraceDirection::code

fn TraceDirection::code(self : TraceDirection) -> Int

#
TraceDirection::label

fn TraceDirection::label(self : TraceDirection) -> String

#
TraceEvent

pub(all) struct TraceEvent {
event_id : Int
parent_id : Int?
vtime :
VTime

clock_domain : String
raw_ns : Int64
node_id : String
medium_id : String
channel_id :
ChannelId
?
direction : TraceDirection
payload_digest : Int?
rng_step : Int
seed : Int
backend :
BackendProfile

label : String
} derive(Eq,
Debug
)

#
TraceEvent::make

fn TraceEvent::make(event_id~ : Int, parent_id~ : Int?, vtime~ :
VTime
, clock_domain~ : String, raw_ns~ : Int64, node_id~ : String, medium_id~ : String, channel_id~ :
ChannelId
?, direction~ : TraceDirection, payload_digest~ : Int?, rng_step~ : Int, seed~ : Int, backend~ :
BackendProfile
, label~ : String) -> TraceEvent

#
TraceEvent::to_golden_line

fn TraceEvent::to_golden_line(self : TraceEvent) -> String

#
TraceLog

pub(all) struct TraceLog {
events : Array[TraceEvent]
} derive(
Debug
)

#
TraceLog::append

fn TraceLog::append(self : TraceLog, event : TraceEvent) -> Unit

#
TraceLog::benchmark_report

fn TraceLog::benchmark_report(self : TraceLog, scenario~ : String, seed~ : Int, backend~ :
BackendProfile
, copies_per_frame~ : Int) -> RuntimeBenchmarkReport

#
TraceLog::digest

#
TraceLog::len

fn TraceLog::len(self : TraceLog) -> Int

#
TraceLog::new

fn TraceLog::new() -> TraceLog

#
TraceLog::portable_digest

fn TraceLog::portable_digest(self : TraceLog, seed~ : Int) ->
SimDigest

#
TraceLog::to_artifact

fn TraceLog::to_artifact(self : TraceLog, seed~ : Int) -> TraceArtifact

#
TraceLog::to_golden_text

fn TraceLog::to_golden_text(self : TraceLog) -> String

#
TraceLog::to_pcapng

fn TraceLog::to_pcapng(self : TraceLog, seed~ : Int) -> Bytes

#
package_id

fn package_id() -> String

#
parse_trace_artifact_text

fn parse_trace_artifact_text(text : String) -> TraceArtifact raise TraceArtifactError

#
parse_trace_log_text

fn parse_trace_log_text(text : String) -> TraceLog raise TraceArtifactError

#
parse_trace_pcapng

fn parse_trace_pcapng(bytes : Bytes) -> TraceArtifact raise TraceArtifactError

#
payload_digest_placeholder

fn payload_digest_placeholder(payload : Bytes) -> Int

#
pcapng_custom_block_type

fn pcapng_custom_block_type() -> Int

#
pcapng_linktype_ethernet

fn pcapng_linktype_ethernet() -> Int

#
rx_event_to_trace

fn rx_event_to_trace(ev :
RxEvent
, seed~ : Int, rng_step~ : Int, clock_domain~ : String, node_id~ : String, medium_id~ : String, backend~ :
BackendProfile
) -> TraceEvent

#
tx_event_to_trace

fn tx_event_to_trace(ev :
TxEvent
, seed~ : Int, rng_step~ : Int, clock_domain~ : String, node_id~ : String, medium_id~ : String, backend~ :
BackendProfile
) -> TraceEvent