Struct re_sdk::recording_stream::RecordingStreamBuilder

pub struct RecordingStreamBuilder {
    application_id: ApplicationId,
    store_kind: StoreKind,
    store_id: Option<StoreId>,
    store_source: Option<StoreSource>,
    default_enabled: bool,
    enabled: Option<bool>,
    batcher_config: Option<ChunkBatcherConfig>,
    is_official_example: bool,
}

Construct a RecordingStream.

let rec = RecordingStreamBuilder::new("rerun_example_app").save("my_recording.rrd")?;

Fields

application_id: ApplicationId

store_kind: StoreKind

store_id: Option<StoreId>

store_source: Option<StoreSource>

default_enabled: bool

enabled: Option<bool>

batcher_config: Option<ChunkBatcherConfig>

is_official_example: bool

Implementations

impl RecordingStreamBuilder

pub fn new(application_id: impl Into<ApplicationId>) -> Self

Create a new RecordingStreamBuilder with the given ApplicationId.

The ApplicationId is usually the name of your app.

let rec = RecordingStreamBuilder::new("rerun_example_app").save("my_recording.rrd")?;

pub fn default_enabled(self, default_enabled: bool) -> Self

Set whether or not Rerun is enabled by default.

If the RERUN environment variable is set, it will override this.

Set also: Self::enabled.

pub fn enabled(self, enabled: bool) -> Self

Set whether or not Rerun is enabled.

Setting this will ignore the RERUN environment variable.

Set also: Self::default_enabled.

pub fn recording_id(self, recording_id: impl Into<String>) -> Self

Set the RecordingId for this context.

If you’re logging from multiple processes and want all the messages to end up in the same recording, you must make sure that they all set the same RecordingId using this function.

Note that many stores can share the same ApplicationId, but they all have unique RecordingIds.

The default is to use a random RecordingId.

pub fn store_id(self, store_id: StoreId) -> Self

Set the StoreId for this context.

If you’re logging from multiple processes and want all the messages to end up as the same store, you must make sure they all set the same StoreId using this function.

Note that many stores can share the same ApplicationId, but they all have unique StoreIds.

The default is to use a random StoreId.

pub fn batcher_config(self, config: ChunkBatcherConfig) -> Self

Specifies the configuration of the internal data batching mechanism.

See ChunkBatcher & ChunkBatcherConfig for more information.

pub fn buffered(self) -> RecordingStreamResult<RecordingStream>

Creates a new RecordingStream that starts in a buffering state (RAM).

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app").buffered()?;

pub fn memory( self ) -> RecordingStreamResult<(RecordingStream, MemorySinkStorage)>

Creates a new RecordingStream that is pre-configured to stream the data through to a crate::log_sink::MemorySink.

Example

let (rec, storage) = re_sdk::RecordingStreamBuilder::new("rerun_example_app").memory()?;

log_data(&rec);

let data = storage.take();

pub fn connect(self) -> RecordingStreamResult<RecordingStream>

👎Deprecated since 0.20.0: use connect_tcp() instead

Creates a new RecordingStream that is pre-configured to stream the data through to a remote Rerun instance.

See also Self::connect_opts if you wish to configure the TCP connection.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app").connect()?;

pub fn connect_tcp(self) -> RecordingStreamResult<RecordingStream>

Creates a new RecordingStream that is pre-configured to stream the data through to a remote Rerun instance.

See also Self::connect_opts if you wish to configure the TCP connection.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app").connect_tcp()?;

pub fn connect_opts( self, addr: SocketAddr, flush_timeout: Option<Duration> ) -> RecordingStreamResult<RecordingStream>

👎Deprecated since 0.20.0: use connect_tcp_opts() instead

Creates a new RecordingStream that is pre-configured to stream the data through to a remote Rerun instance.

flush_timeout is the minimum time the TcpSink will wait during a flush before potentially dropping data. Note: Passing None here can cause a call to flush to block indefinitely if a connection cannot be established.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app")
    .connect_opts(re_sdk::default_server_addr(), re_sdk::default_flush_timeout())?;

pub fn connect_tcp_opts( self, addr: SocketAddr, flush_timeout: Option<Duration> ) -> RecordingStreamResult<RecordingStream>

Creates a new RecordingStream that is pre-configured to stream the data through to a remote Rerun instance.

flush_timeout is the minimum time the TcpSink will wait during a flush before potentially dropping data. Note: Passing None here can cause a call to flush to block indefinitely if a connection cannot be established.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app")
    .connect_opts(re_sdk::default_server_addr(), re_sdk::default_flush_timeout())?;

pub fn save( self, path: impl Into<PathBuf> ) -> RecordingStreamResult<RecordingStream>

Creates a new RecordingStream that is pre-configured to stream the data through to an RRD file on disk.

The Rerun Viewer is able to read continuously from the resulting rrd file while it is being written. However, depending on your OS and configuration, changes may not be immediately visible due to file caching. This is a common issue on Windows and (to a lesser extent) on MacOS.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app").save("my_recording.rrd")?;

pub fn stdout(self) -> RecordingStreamResult<RecordingStream>

Creates a new RecordingStream that is pre-configured to stream the data through to stdout.

If there isn’t any listener at the other end of the pipe, the RecordingStream will default back to buffered mode, in order not to break the user’s terminal.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app").stdout()?;

pub fn spawn(self) -> RecordingStreamResult<RecordingStream>

Spawns a new Rerun Viewer process from an executable available in PATH, then creates a new RecordingStream that is pre-configured to stream the data through to that viewer over TCP.

If a Rerun Viewer is already listening on this TCP port, the stream will be redirected to that viewer instead of starting a new one.

See also Self::spawn_opts if you wish to configure the behavior of thew Rerun process as well as the underlying TCP connection.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app").spawn()?;

pub fn spawn_opts( self, opts: &SpawnOptions, flush_timeout: Option<Duration> ) -> RecordingStreamResult<RecordingStream>

Spawns a new Rerun Viewer process from an executable available in PATH, then creates a new RecordingStream that is pre-configured to stream the data through to that viewer over TCP.

If a Rerun Viewer is already listening on this TCP port, the stream will be redirected to that viewer instead of starting a new one.

The behavior of the spawned Viewer can be configured via opts. If you’re fine with the default behavior, refer to the simpler Self::spawn.

flush_timeout is the minimum time the TcpSink will wait during a flush before potentially dropping data. Note: Passing None here can cause a call to flush to block indefinitely if a connection cannot be established.

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app")
    .spawn_opts(&re_sdk::SpawnOptions::default(), re_sdk::default_flush_timeout())?;

pub fn serve( self, bind_ip: &str, web_port: WebViewerServerPort, ws_port: RerunServerPort, server_memory_limit: MemoryLimit, open_browser: bool ) -> RecordingStreamResult<RecordingStream>

👎Deprecated since 0.20.0: use serve_web() instead

Creates a new RecordingStream that is pre-configured to stream the data through to a web-based Rerun viewer via WebSockets.

If the open_browser argument is true, your default browser will be opened with a connected web-viewer.

If not, you can connect to this server using the rerun binary (cargo install rerun-cli --locked).

Details

This method will spawn two servers: one HTTPS server serving the Rerun Web Viewer .html and .wasm files, and then one WebSocket server that streams the log data to the web viewer (or to a native viewer, or to multiple viewers).

The WebSocket server will buffer all log data in memory so that late connecting viewers will get all the data. You can limit the amount of data buffered by the WebSocket server with the server_memory_limit argument. Once reached, the earliest logged data will be dropped. Note that this means that static data may be dropped if logged early (see https://github.com/rerun-io/rerun/issues/5531).

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app")
    .serve("0.0.0.0",
           Default::default(),
           Default::default(),
           re_sdk::MemoryLimit::from_fraction_of_total(0.25),
           true)?;

pub fn serve_web( self, bind_ip: &str, web_port: WebViewerServerPort, ws_port: RerunServerPort, server_memory_limit: MemoryLimit, open_browser: bool ) -> RecordingStreamResult<RecordingStream>

Creates a new RecordingStream that is pre-configured to stream the data through to a web-based Rerun viewer via WebSockets.

If the open_browser argument is true, your default browser will be opened with a connected web-viewer.

If not, you can connect to this server using the rerun binary (cargo install rerun-cli --locked).

Details

This method will spawn two servers: one HTTPS server serving the Rerun Web Viewer .html and .wasm files, and then one WebSocket server that streams the log data to the web viewer (or to a native viewer, or to multiple viewers).

The WebSocket server will buffer all log data in memory so that late connecting viewers will get all the data. You can limit the amount of data buffered by the WebSocket server with the server_memory_limit argument. Once reached, the earliest logged data will be dropped. Note that this means that static data may be dropped if logged early (see https://github.com/rerun-io/rerun/issues/5531).

Example

let rec = re_sdk::RecordingStreamBuilder::new("rerun_example_app")
    .serve_web("0.0.0.0",
               Default::default(),
               Default::default(),
               re_sdk::MemoryLimit::from_fraction_of_total(0.25),
               true)?;

pub fn into_args(self) -> (bool, StoreInfo, ChunkBatcherConfig)

Returns whether or not logging is enabled, a StoreInfo and the associated batcher configuration.

This can be used to then construct a RecordingStream manually using RecordingStream::new.

fn is_enabled(&self) -> bool

Internal check for whether or not logging is enabled using explicit/default settings & env var.

Trait Implementations

impl Debug for RecordingStreamBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.