Crate rerun

source ·
Expand description

The main Rerun library and binary.

Examples

See https://github.com/rerun-io/rerun/tree/latest/examples/rust.

Library

See Session and MsgSender.

Binary

This can act either as a server, a viewer, or both, depending on which options you use when you start it.

Feature flags

  • analytics (enabled by default) — Enable telemetry using our analytics SDK.

  • glam — Add support for some math operations using glam. Only relevant if feature sdk is enabled.

  • image (enabled by default) — Integration with the image crate.

  • sdk (enabled by default) — Embed the Rerun SDK and re-export all of its public symbols.

  • server (enabled by default) — Support for running a HTTP server that listens to incoming log messages from a Rerun SDK.

  • web — Support serving a web viewer over HTTP.

    Enabling this adds quite a bit to the compile time and binary size, since it requires compiling and bundling the viewer as wasm.

    You also need to install some additional tools, which you can do by running scripts/setup_web.sh.

Modules

components
These are the different components you can log.
coordinates
Coordinate system helpers, for use with components::ViewCoordinates.
demo_util
This module contains utilities to support Rerun examples.
external
Re-exports of other crates.
log
Things directly related to logging.
time
Time-related types.

Structs

ApplicationId
The user-chosen name of the application doing the logging.
ComponentName
The name of an entity component, e.g. pos or color.
EntityPath
camera / "left" / points / #42
MsgSender
Facilitates building and sending component payloads with the Rerun SDK.
RecordingId
A unique id per recording (a stream of LogMsges).
Session
This is the main object you need to create to use the Rerun SDK.

Enums

CallSource
Where are we calling run from?
MsgSenderError
Errors that can occur when constructing or sending messages using MsgSender.

Traits

Component
A type that can used as a Component of an Entity.
SerializableComponent
A trait to identify any Component that is ready to be collected and subsequently serialized into an Arrow payload.

Functions

global_session
Access a global Session singleton for convenient logging.
run
Run the Rerun application and return an exit code.