Lib.rs

Cargo Features

[dependencies]
rerun = { version = "0.20.1", default-features = false, features = ["analytics", "clap", "data_loaders", "demo", "dataframe", "glam", "mint", "image", "ecolor", "log", "nasm", "native_viewer", "map_view", "grpc", "run", "server", "sdk", "web_viewer"] }

default = analytics, data_loaders, dataframe, demo, glam, image, log, sdk, server

These default features are set whenever rerun is added without default-features = false somewhere in the dependency tree.

analytics default

Enable telemetry using our analytics SDK.

Enables analytics of re_crash_handler, optional re_viewer, and optional re_web_viewer_server and re_analytics

Optional dependencies:

clap run?

Integration with clap.

Enables clap

Affects rerun::clap…

data_loaders default

Support for using Rerun's data-loaders directly from the SDK.

See our log_file example and https://www.rerun.io/docs/reference/data-loaders/overview for more information.

Enables data_loaders of optional re_sdk

demo default

Demo helpers for examples.

Affects rerun::demo_util…

dataframe default

Access to Rerun's dataframe API and related types.

Enables re_dataframe

Affects rerun::dataframe…

glam default

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

Enables glam of optional re_types

Affects demo_util::grid, demo_util::color_spiral…

mint

Add support for math type conversions using mint. Only relevant if feature sdk is enabled.

Enables mint of optional re_types

image default

Integration with the image crate, plus JPEG support.

Enables image of optional re_types

ecolor

Integration with the ecolor crate.

Enables ecolor of optional re_types

log default

Integration with the log crate.

Enables env_logger ^0.10 and log

Affects rerun::log_integration…

nasm

Enable faster native video decoding with assembly. You need to install nasm to compile with this feature.

Enables nasm of re_video

native_viewer

Support spawning a native viewer.
This adds a lot of extra dependencies, so only enable this feature if you need it!

Enables re_viewer

Affects rerun::native_viewer…

map_view

Support the map view.
This adds a lot of extra dependencies.
TODO(#7876): remove this feature when we have fewer dependencies

Enables map_view of optional re_viewer

grpc

Enable the gRPC Rerun Data Platform data source.

Enables grpc of re_viewer

run = clap, sdk, unindent

Add support for the [run()] function, which acts like a main-function for a CLI, acting the same as the rerun binary.

Enables re_chunk_store, re_data_source, re_log_encoding, re_sdk_comms, and re_ws_comms

server default web_viewer?

Support for running a TCP server that listens to incoming log messages from a Rerun SDK.

Enables server of optional re_sdk_comms

sdk default run?

Embed the Rerun SDK & built-in types and re-export all of their public symbols.

Enables re_sdk and re_types

Affects rerun::native_viewer…

web_viewer = server

Support serving a web viewer over HTTP.

Enabling this inflates the binary size quite a bit, since it embeds the viewer wasm.

For faster & easier builds, a pre-built web-views comes bundled with the crate as a Wasm binary.
Enabling this feature will embed this pre-built web viewer.

However, when building from source in the repository, this feature adds quite a bit to the compile time since it requires compiling and bundling the viewer as wasm.

Enables re_web_viewer_server, web_viewer of optional re_sdk

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

unindent not wasm32 run?