Crate re_sdk

Expand description

The Rerun SDK

analytics — Enable telemetry using our analytics SDK.
demo (enabled by default) — Enable the demo module (helpers for Rerun examples).
glam (enabled by default) — Add support for some math operations using glam.
image (enabled by default) — Integration with the image crate.
native_viewer (enabled by default) — Support for the native viewer.
web_viewer — 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

clap
This module provides integration with integration with clap.
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.

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.

MsgSenderError
Errors that can occur when constructing or sending messages using MsgSender.

Component
A type that can used as a Component of an Entity.
SerializableComponent
A Component that fulfils all the conditions required to be serialized as an Arrow payload.

default_server_addr
The default address of a Rerun TCP server which an SDK connects to.
global_session
Access a global Session singleton for convenient logging.
global_session_with_default_enabled
Access a global Session singleton for convenient logging.