Skip to main content

Crate seismograph_rallocator

Crate seismograph_rallocator 

Source
Expand description

Rallocator snapshot source for seismograph.

Rallocator contributes this payload to the process-wide seismograph snapshot. Snapshot data is organized into snapshot, topology, and callers.

§Compatibility contract

A snapshot has three layers with independent versions:

  • The private wire layer owns the little-endian container header and length-prefixed section framing. A framing change increments the wire version, and readers reject unknown wire versions.
  • This crate owns the telemetry schema named by the header. A change that reinterprets the snapshot as a whole increments that schema; readers reject unsupported schema versions.
  • Each section owns its payload version. Compatible extensions increment only that section version. Unknown sections and unsupported optional section versions are skipped and reported through snapshot::Snapshot::skipped_sections.

Metadata and statistics sections are required. Historical section versions accepted by the decoder receive documented neutral defaults for fields that did not yet exist. Producers must not change the meaning or byte order of an existing version.

Modules§

callers
Retained caller and symbol model types.
snapshot
Rallocator snapshot model types.
source
Stable identity and schema metadata for the rallocator snapshot source.
topology
Rallocator virtual-address topology model types.

Structs§

Error
An error reported while encoding or decoding a telemetry snapshot.
WireError
Error produced by low-level snapshot framing. An error reported while reading or writing the wire format.

Enums§

ErrorKind
Stable category of a telemetry encoding or decoding error.
WireErrorKind
Stable category of a low-level snapshot framing error. Stable category of a wire-format error.

Functions§

decode
Decodes a snapshot from wire bytes.
encode
Encodes snapshot into an exactly sized output buffer.
encoded_len
Returns the exact byte length required to encode snapshot.