Crate rerun::external::re_log_types
source · Expand description
The different types that make up the rerun log format.
§Feature flags
serde— Enable (de)serialization using serde.
§Mono-components
Some components, mostly transform related ones, are “mono-components”. This means that Rerun makes assumptions that depend on this component only taking on a singular value for all instances of an Entity. Where possible, exposed APIs will force these components to be logged as a singular instance. However, it is an error with undefined behavior to manually use lower-level APIs to log a batched mono-component.
This requirement is especially apparent with transforms:
Each entity must have a unique transform chain,
e.g. the entity foo/bar/baz is has the transform that is the product of
foo.transform * foo/bar.transform * foo/bar/baz.transform.
Modules§
ArrowMsgis thecrate::LogMsgsub-type containing an Arrow payload.- Example components to be used for tests and docs
- Every logged entity in Rerun is logged to an
EntityPath.
Macros§
- Build an
EntityPathfrom parts that are not escaped: - Build a
Vec<EntityPathPart>:
Structs§
- The user-chosen name of the application doing the logging.
- Message containing an Arrow payload
- Command used for activating a blueprint once it has been fully transmitted.
- A
EntityPathplus aComponentName. - A cell’s worth of data, i.e. a uniform array of values for a given component type. This is the leaf type in our data model.
- The actual contents of a
DataCell. - A general path to some data.
- A row’s worth of data, i.e. an event: a list of
DataCells associated with an auto-generatedRowId, a user-specifiedTimePointandEntityPath, and an expected number of instances. This is the middle layer in our data model. - A sparse table’s worth of data, i.e. a batch of events: a collection of
DataRows. This is the top-level layer in our data model. - Implements an asynchronous batcher that coalesces
DataRows intoDataTables based upon the thresholds defined in the associatedDataTableBatcherConfig. - Defines the different thresholds of the associated
DataTableBatcher. - A signed duration represented as nanoseconds since unix epoch
- The unique identifier of an entity, e.g.
camera/3/points - A way to filter a set of
EntityPaths. - A 64 bit hash of
EntityPathwith very small risk of collision. - The different parts that make up an
EntityPath. - A set of substitutions for entity paths.
- A unique numeric index for each individual instance within a batch.
- Like
ResolvedTimeRange, but usingTimeRealfor improved precision. - A unique ID for a
DataRow. - A unique id per store.
- Information about a recording or blueprint.
- A unique ID for a
DataTable. - A date-time represented as nanoseconds since unix epoch
- A 64-bit number describing either nanoseconds, sequence numbers or fully static data.
- A point in time on any number of
Timelines. - Either nanoseconds or sequence numbers.
- A time frame/space, e.g.
log_timeorframe_nr, coupled with the type of time it keeps. - The name of a timeline. Often something like
"log_time"or"frame_nr". - An error type returned when a checked integral type conversion fails (mimics
std::num::TryFromIntError)
Enums§
- An error that can occur because a row in the store has inconsistent columns.
- A problem with a row of data in the store.
- Errors that can occur when creating/manipulating a
DataTableBatcher. - The most general log message sent from the SDK to the server.
- What kind of Store this is.
- The source of a recording or blueprint.
Constants§
Traits§
- Extends
VecDequewith extra insertion routines. - Extends
VecDequewith extra removal routines. - Extends
VecDequewith extra sorting routines.