Struct RecordingStream
pub struct RecordingStream { /* private fields */ }Expand description
A RecordingStream handles everything related to logging data into Rerun.
You can construct a new RecordingStream using [RecordingStreamBuilder] or
RecordingStream::new.
§Sinks
Data is logged into Rerun via [LogSink]s.
The underlying [LogSink] of a RecordingStream can be changed at any point during its
lifetime by calling RecordingStream::set_sink or one of the higher level helpers
(RecordingStream::connect_grpc, RecordingStream::memory,
RecordingStream::save, RecordingStream::disconnect).
See RecordingStream::set_sink for more information.
§Multithreading and ordering
RecordingStream can be cheaply cloned and used freely across any number of threads.
Internally, all operations are linearized into a pipeline:
- All operations sent by a given thread will take effect in the same exact order as that thread originally sent them in, from its point of view.
- There isn’t any well defined global order across multiple threads.
This means that e.g. flushing the pipeline (Self::flush_blocking) guarantees that all previous data sent by the calling thread
has been recorded and (if applicable) flushed to the underlying OS-managed file descriptor,
but other threads may still have data in flight.
§Shutdown
The RecordingStream can only be shutdown by dropping all instances of it, at which point
it will automatically take care of flushing any pending data that might remain in the pipeline.
Shutting down cannot ever block.
Implementations§
§impl RecordingStream
impl RecordingStream
pub fn get(
kind: StoreKind,
overrides: Option<RecordingStream>,
) -> Option<RecordingStream>
pub fn get( kind: StoreKind, overrides: Option<RecordingStream>, ) -> Option<RecordingStream>
Returns overrides if it exists, otherwise returns the most appropriate active recording
of the specified type (i.e. thread-local first, then global scope), if any.
pub fn global(kind: StoreKind) -> Option<RecordingStream>
pub fn global(kind: StoreKind) -> Option<RecordingStream>
Returns the currently active recording of the specified type in the global scope, if any.
pub fn set_global(
kind: StoreKind,
rec: Option<RecordingStream>,
) -> Option<RecordingStream>
pub fn set_global( kind: StoreKind, rec: Option<RecordingStream>, ) -> Option<RecordingStream>
Replaces the currently active recording of the specified type in the global scope with the specified one.
Returns the previous one, if any.
pub fn forget_global(kind: StoreKind)
pub fn forget_global(kind: StoreKind)
Forgets the currently active recording of the specified type in the global scope.
WARNING: this intentionally bypasses any drop/flush logic. This should only ever be used in cases where you know the batcher/sink threads have been lost such as in a forked process.
pub fn thread_local(kind: StoreKind) -> Option<RecordingStream>
pub fn thread_local(kind: StoreKind) -> Option<RecordingStream>
Returns the currently active recording of the specified type in the thread-local scope, if any.
pub fn set_thread_local(
kind: StoreKind,
rec: Option<RecordingStream>,
) -> Option<RecordingStream>
pub fn set_thread_local( kind: StoreKind, rec: Option<RecordingStream>, ) -> Option<RecordingStream>
Replaces the currently active recording of the specified type in the thread-local scope with the specified one.
pub fn forget_thread_local(kind: StoreKind)
pub fn forget_thread_local(kind: StoreKind)
Forgets the currently active recording of the specified type in the thread-local scope.
WARNING: this intentionally bypasses any drop/flush logic. This should only ever be used in cases where you know the batcher/sink threads have been lost such as in a forked process.
§impl RecordingStream
impl RecordingStream
pub fn clone_weak(&self) -> RecordingStream
pub fn clone_weak(&self) -> RecordingStream
Clones the RecordingStream without incrementing the refcount.
Useful e.g. if you want to make sure that a detached thread won’t prevent the RecordingStream
from flushing during shutdown.
pub fn ref_count(&self) -> usize
pub fn ref_count(&self) -> usize
Returns the current reference count of the RecordingStream.
Returns 0 if the stream was created by RecordingStream::disabled(),
or if it is a clone_weak() of a stream whose strong instances
have all been dropped.
§impl RecordingStream
impl RecordingStream
pub fn new(
store_info: StoreInfo,
recording_info: Option<RecordingInfo>,
batcher_config: Option<ChunkBatcherConfig>,
batcher_hooks: BatcherHooks,
sink: Box<dyn LogSink>,
) -> Result<RecordingStream, RecordingStreamError>
pub fn new( store_info: StoreInfo, recording_info: Option<RecordingInfo>, batcher_config: Option<ChunkBatcherConfig>, batcher_hooks: BatcherHooks, sink: Box<dyn LogSink>, ) -> Result<RecordingStream, RecordingStreamError>
Creates a new RecordingStream with a given [StoreInfo] and [LogSink].
You can create a [StoreInfo] with [crate::new_store_info];
The [StoreInfo] is immediately sent to the sink in the form of a
[re_log_types::SetStoreInfo].
You can find sinks in [crate::sink].
If no batcher configuration is provided, the default batcher configuration for the sink will be used.
Any environment variables as specified in [ChunkBatcherConfig] will always override respective settings.
See also: [RecordingStreamBuilder].
pub const fn disabled() -> RecordingStream
pub const fn disabled() -> RecordingStream
Creates a new no-op RecordingStream that drops all logging messages, doesn’t allocate
any memory and doesn’t spawn any threads.
Self::is_enabled will return false.
§impl RecordingStream
impl RecordingStream
pub fn log<AS>(
&self,
ent_path: impl Into<EntityPath>,
as_components: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
pub fn log<AS>(
&self,
ent_path: impl Into<EntityPath>,
as_components: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
Log data to Rerun.
This is the main entry point for logging data to rerun. It can be used to log anything
that implements the [AsComponents], such as any archetype
or individual component.
The data will be timestamped automatically based on the RecordingStream’s internal clock.
See RecordingStream::set_time_sequence etc for more information.
The entity path can either be a string
(with special characters escaped, split on unescaped slashes)
or an [EntityPath] constructed with [crate::entity_path].
See https://www.rerun.io/docs/concepts/entity-path for more on entity paths.
See also: Self::log_static for logging static data.
Internally, the stream will automatically micro-batch multiple log calls to optimize transport. See SDK Micro Batching for more information.
§Example:
rec.log(
"my/points",
&rerun::Points3D::new([(0.0, 0.0, 0.0), (1.0, 1.0, 1.0)]),
)?;§Thread Safety
While RecordingStream is Send + Sync and safe to use from multiple threads,
avoid calling log while holding a std::sync::Mutex. The rerun SDK uses
rayon internally for parallel processing, and rayon’s
work-stealing behavior can cause deadlocks when combined with held mutexes
(see rayon#592).
// ❌ Don't do this - potential deadlock:
let guard = mutex.lock().unwrap();
stream.log("data", &rerun::Points3D::new(points))?;
drop(guard);
// ✅ Do this instead - extract data first:
let points = {
let guard = mutex.lock().unwrap();
guard.points.clone()
};
stream.log("data", &rerun::Points3D::new(points))?;pub fn send_columns(
&self,
ent_path: impl Into<EntityPath>,
indexes: impl IntoIterator<Item = TimeColumn>,
columns: impl IntoIterator<Item = SerializedComponentColumn>,
) -> Result<(), RecordingStreamError>
pub fn send_columns( &self, ent_path: impl Into<EntityPath>, indexes: impl IntoIterator<Item = TimeColumn>, columns: impl IntoIterator<Item = SerializedComponentColumn>, ) -> Result<(), RecordingStreamError>
Lower-level logging API to provide data spanning multiple timepoints.
Unlike the regular log API, which is row-oriented, this API lets you submit the data
in a columnar form. The lengths of all of the [TimeColumn] and the component columns
must match. All data that occurs at the same index across the different index/time and components
arrays will act as a single logical row.
Note that this API ignores any stateful index/time set on the log stream via the
Self::set_time/Self::set_timepoint/etc. APIs.
Furthermore, this will not inject the default timelines log_tick and log_time timeline columns.
pub fn log_static<AS>(
&self,
ent_path: impl Into<EntityPath>,
as_components: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
pub fn log_static<AS>(
&self,
ent_path: impl Into<EntityPath>,
as_components: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
Log data to Rerun.
It can be used to log anything
that implements the [AsComponents], such as any archetype
or individual component.
Static data has no time associated with it, exists on all timelines, and unconditionally shadows any temporal data of the same type. All timestamp data associated with this message will be dropped right before sending it to Rerun.
This is most often used for rerun::ViewCoordinates and
rerun::AnnotationContext.
Internally, the stream will automatically micro-batch multiple log calls to optimize transport. See SDK Micro Batching for more information.
See also Self::log.
pub fn log_with_static<AS>(
&self,
ent_path: impl Into<EntityPath>,
static_: bool,
as_components: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
pub fn log_with_static<AS>(
&self,
ent_path: impl Into<EntityPath>,
static_: bool,
as_components: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
Logs the contents of a component bundle into Rerun.
If static_ is set to true, all timestamp data associated with this message will be
dropped right before sending it to Rerun.
Static data has no time associated with it, exists on all timelines, and unconditionally shadows
any temporal data of the same type.
Otherwise, the data will be timestamped automatically based on the RecordingStream’s
internal clock.
See RecordingStream::set_time_* family of methods for more information.
The entity path can either be a string
(with special characters escaped, split on unescaped slashes)
or an [EntityPath] constructed with [crate::entity_path].
See https://www.rerun.io/docs/concepts/entity-path for more on entity paths.
Internally, the stream will automatically micro-batch multiple log calls to optimize transport. See SDK Micro Batching for more information.
pub fn log_serialized_batches(
&self,
ent_path: impl Into<EntityPath>,
static_: bool,
comp_batches: impl IntoIterator<Item = SerializedComponentBatch>,
) -> Result<(), RecordingStreamError>
pub fn log_serialized_batches( &self, ent_path: impl Into<EntityPath>, static_: bool, comp_batches: impl IntoIterator<Item = SerializedComponentBatch>, ) -> Result<(), RecordingStreamError>
Logs a set of SerializedComponentBatches into Rerun.
If static_ is set to true, all timestamp data associated with this message will be
dropped right before sending it to Rerun.
Static data has no time associated with it, exists on all timelines, and unconditionally shadows
any temporal data of the same type.
Otherwise, the data will be timestamped automatically based on the RecordingStream’s
internal clock.
See RecordingStream::set_time_* family of methods for more information.
The number of instances will be determined by the longest batch in the bundle.
The entity path can either be a string
(with special characters escaped, split on unescaped slashes)
or an [EntityPath] constructed with [crate::entity_path].
See https://www.rerun.io/docs/concepts/entity-path for more on entity paths.
Internally, the stream will automatically micro-batch multiple log calls to optimize transport. See SDK Micro Batching for more information.
pub fn send_property<AS>(
&self,
name: impl Into<String>,
values: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
pub fn send_property<AS>(
&self,
name: impl Into<String>,
values: &AS,
) -> Result<(), RecordingStreamError>where
AS: AsComponents + ?Sized,
Sends a property to the recording.
pub fn send_recording_name(
&self,
name: impl Into<String>,
) -> Result<(), RecordingStreamError>
pub fn send_recording_name( &self, name: impl Into<String>, ) -> Result<(), RecordingStreamError>
Sends the name of the recording.
pub fn send_recording_start_time(
&self,
timestamp: impl Into<Timestamp>,
) -> Result<(), RecordingStreamError>
pub fn send_recording_start_time( &self, timestamp: impl Into<Timestamp>, ) -> Result<(), RecordingStreamError>
Sends the start time of the recording.
§impl RecordingStream
impl RecordingStream
pub fn is_enabled(&self) -> bool
pub fn is_enabled(&self) -> bool
Check if logging is enabled on this RecordingStream.
If not, all recording calls will be ignored.
pub fn store_info(&self) -> Option<StoreInfo>
pub fn store_info(&self) -> Option<StoreInfo>
The [StoreInfo] associated with this RecordingStream.
pub fn is_forked_child(&self) -> bool
pub fn is_forked_child(&self) -> bool
Determine whether a fork has happened since creating this RecordingStream. In general, this means our
batcher/sink threads are gone and all data logged since the fork has been dropped.
It is essential that [crate::cleanup_if_forked_child] be called after forking the process. SDK-implementations
should do this during their initialization phase.
§impl RecordingStream
impl RecordingStream
pub fn record_msg(&self, msg: LogMsg)
pub fn record_msg(&self, msg: LogMsg)
Records an arbitrary [LogMsg].
pub fn record_row(
&self,
entity_path: EntityPath,
row: PendingRow,
inject_time: bool,
)
pub fn record_row( &self, entity_path: EntityPath, row: PendingRow, inject_time: bool, )
Records a single [PendingRow].
If inject_time is set to true, the row’s timestamp data will be overridden using the
RecordingStream’s internal clock.
Internally, incoming [PendingRow]s are automatically coalesced into larger [Chunk]s to
optimize for transport.
pub fn log_chunk(&self, chunk: Chunk)
pub fn log_chunk(&self, chunk: Chunk)
Logs a single [Chunk].
Will inject log_tick and log_time timeline columns into the chunk.
If you don’t want to inject these, use Self::send_chunk instead.
pub fn log_chunks(&self, chunks: impl IntoIterator<Item = Chunk>)
pub fn log_chunks(&self, chunks: impl IntoIterator<Item = Chunk>)
Logs multiple [Chunk]s.
This will not inject log_tick and log_time timeline columns into the chunk,
for that use Self::log_chunks.
pub fn send_chunk(&self, chunk: Chunk)
pub fn send_chunk(&self, chunk: Chunk)
Records a single [Chunk].
Will inject log_tick and log_time timeline columns into the chunk.
If you don’t want to inject these, use Self::send_chunks instead.
pub fn send_chunks(&self, chunks: impl IntoIterator<Item = Chunk>)
pub fn send_chunks(&self, chunks: impl IntoIterator<Item = Chunk>)
Records multiple [Chunk]s.
This will not inject log_tick and log_time timeline columns into the chunk,
for that use Self::log_chunks.
pub fn set_sink(&self, new_sink: Box<dyn LogSink>)
pub fn set_sink(&self, new_sink: Box<dyn LogSink>)
Swaps the underlying sink for a new one.
This guarantees that:
- all pending rows and chunks are batched, collected and sent down the current sink,
- the current sink is flushed if it has pending data in its buffers,
- the current sink’s backlog, if there’s any, is forwarded to the new sink.
When this function returns, the calling thread is guaranteed that all future record calls will end up in the new sink.
If the batcher’s configuration has not been set explicitly or by environment variables, this will change the batcher configuration to the sink’s default configuration.
§Data loss
If the current sink is in a broken state (e.g. a gRPC sink with a broken connection that cannot be repaired), all pending data in its buffers will be dropped.
pub fn flush_async(&self) -> Result<(), SinkFlushError>
pub fn flush_async(&self) -> Result<(), SinkFlushError>
Initiates a flush of the pipeline and returns immediately.
This does not wait for the flush to propagate (see Self::flush_blocking).
See RecordingStream docs for ordering semantics and multithreading guarantees.
This will never return [SinkFlushError::Timeout].
pub fn flush_blocking(&self) -> Result<(), SinkFlushError>
pub fn flush_blocking(&self) -> Result<(), SinkFlushError>
Flush the batching pipeline and waits for it to propagate.
The function will block until either the flush has completed successfully (Ok),
an error has occurred (SinkFlushError::Failed), or the timeout is reached (SinkFlushError::Timeout).
Convenience for calling Self::flush_with_timeout with a timeout of Duration::MAX
pub fn flush_with_timeout(
&self,
timeout: Duration,
) -> Result<(), SinkFlushError>
pub fn flush_with_timeout( &self, timeout: Duration, ) -> Result<(), SinkFlushError>
Flush the batching pipeline and optionally waits for it to propagate.
If you don’t want a timeout you can pass in Duration::MAX.
The function will block until that timeout is reached,
an error occurs, or the flush is complete.
The function will only block while there is some hope of progress.
For instance: if the underlying gRPC connection is disconnected (or never connected at all),
then [SinkFlushError::Failed] is returned.
See RecordingStream docs for ordering semantics and multithreading guarantees.
§impl RecordingStream
impl RecordingStream
pub fn set_sinks(&self, sinks: impl IntoMultiSink)
pub fn set_sinks(&self, sinks: impl IntoMultiSink)
Stream data to multiple different sinks.
This is semantically the same as calling RecordingStream::set_sink, but the resulting
RecordingStream will now stream data to multiple sinks at the same time.
Currently only supports GrpcSink and FileSink.
If the batcher’s configuration has not been set explicitly or by environment variables, This will take over a conservative default of the new sinks. (there’s no guarantee on when exactly the new configuration will be active)
pub fn inspect_sink(
&self,
f: impl FnOnce(&(dyn LogSink + 'static)) + Send + 'static,
)
pub fn inspect_sink( &self, f: impl FnOnce(&(dyn LogSink + 'static)) + Send + 'static, )
Asynchronously calls a method that has read access to the currently active sink.
Since a recording stream’s sink is owned by a different thread there is no guarantee when the callback is going to be called. It’s advised to return as quickly as possible from the callback since as long as the callback doesn’t return, the sink will not receive any new data,
§Experimental
This is an experimental API and may change in future releases.
pub fn connect_grpc(&self) -> Result<(), RecordingStreamError>
pub fn connect_grpc(&self) -> Result<(), RecordingStreamError>
Swaps the underlying sink for a [crate::log_sink::GrpcSink] sink pre-configured to use
the specified address.
See also Self::connect_grpc_opts if you wish to configure the connection.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
pub fn connect_grpc_opts(
&self,
url: impl Into<String>,
) -> Result<(), RecordingStreamError>
pub fn connect_grpc_opts( &self, url: impl Into<String>, ) -> Result<(), RecordingStreamError>
Swaps the underlying sink for a [crate::log_sink::GrpcSink] sink pre-configured to use
the specified address.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
flush_timeout is the minimum time the [GrpcSink][crate::log_sink::GrpcSink] 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.
pub fn serve_grpc(
&self,
server_options: ServerOptions,
) -> Result<(), RecordingStreamError>
pub fn serve_grpc( &self, server_options: ServerOptions, ) -> Result<(), RecordingStreamError>
Swaps the underlying sink for a [crate::grpc_server::GrpcServerSink] pre-configured to listen on
rerun+http://127.0.0.1:9876/proxy.
To configure the gRPC server’s IP and port, use Self::serve_grpc_opts instead.
You can connect a viewer to it with rerun --connect.
The gRPC 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 gRPC server with the server_options argument.
Once reached, the earliest logged data will be dropped. Static data is never dropped.
pub fn serve_grpc_opts(
&self,
bind_ip: impl AsRef<str>,
port: u16,
server_options: ServerOptions,
) -> Result<(), RecordingStreamError>
pub fn serve_grpc_opts( &self, bind_ip: impl AsRef<str>, port: u16, server_options: ServerOptions, ) -> Result<(), RecordingStreamError>
Swaps the underlying sink for a [crate::grpc_server::GrpcServerSink] pre-configured to listen on
rerun+http://{bind_ip}:{port}/proxy.
0.0.0.0 is a good default for bind_ip.
The gRPC 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 gRPC server with the server_options argument.
Once reached, the earliest logged data will be dropped. Static data is never dropped.
pub fn spawn(&self) -> Result<(), RecordingStreamError>
pub fn spawn(&self) -> Result<(), RecordingStreamError>
Spawns a new Rerun Viewer process from an executable available in PATH, then swaps the
underlying sink for a [crate::log_sink::GrpcSink] sink pre-configured to send data to that
new process.
If a Rerun Viewer is already listening on this 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 connection.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
pub fn spawn_opts(
&self,
opts: &SpawnOptions,
) -> Result<(), RecordingStreamError>
pub fn spawn_opts( &self, opts: &SpawnOptions, ) -> Result<(), RecordingStreamError>
Spawns a new Rerun Viewer process from an executable available in PATH, then swaps the
underlying sink for a [crate::log_sink::GrpcSink] sink pre-configured to send data to that
new process.
If a Rerun Viewer is already listening on this 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.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
flush_timeout is the minimum time the [GrpcSink][crate::log_sink::GrpcSink] 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.
pub fn memory(&self) -> MemorySinkStorage
pub fn memory(&self) -> MemorySinkStorage
Swaps the underlying sink for a [crate::sink::MemorySink] sink and returns the associated
[MemorySinkStorage].
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
pub fn binary_stream(&self) -> BinaryStreamStorage
pub fn binary_stream(&self) -> BinaryStreamStorage
Swaps the underlying sink for a [crate::sink::BinaryStreamSink] sink and returns the associated
[BinaryStreamStorage].
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
pub fn save(&self, path: impl Into<PathBuf>) -> Result<(), FileSinkError>
pub fn save(&self, path: impl Into<PathBuf>) -> Result<(), FileSinkError>
Swaps the underlying sink for a [crate::sink::FileSink] at the specified path.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
pub fn save_opts(&self, path: impl Into<PathBuf>) -> Result<(), FileSinkError>
pub fn save_opts(&self, path: impl Into<PathBuf>) -> Result<(), FileSinkError>
Swaps the underlying sink for a [crate::sink::FileSink] at the specified path.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
If a blueprint was provided, it will be stored first in the file. Blueprints are currently an experimental part of the Rust SDK.
pub fn stdout(&self) -> Result<(), FileSinkError>
pub fn stdout(&self) -> Result<(), FileSinkError>
Swaps the underlying sink for a [crate::sink::FileSink] pointed at 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.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
pub fn stdout_opts(&self) -> Result<(), FileSinkError>
pub fn stdout_opts(&self) -> Result<(), FileSinkError>
Swaps the underlying sink for a [crate::sink::FileSink] pointed at 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.
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
If a blueprint was provided, it will be stored first in the file. Blueprints are currently an experimental part of the Rust SDK.
pub fn disconnect(&self)
pub fn disconnect(&self)
Swaps the underlying sink for a [crate::sink::BufferedSink].
This is a convenience wrapper for Self::set_sink that upholds the same guarantees in
terms of data durability and ordering.
See Self::set_sink for more information.
pub fn send_blueprint(
&self,
blueprint: Vec<LogMsg>,
activation_cmd: BlueprintActivationCommand,
)
pub fn send_blueprint( &self, blueprint: Vec<LogMsg>, activation_cmd: BlueprintActivationCommand, )
Send a blueprint through this recording stream.
pub fn send_blueprint_opts(
&self,
opts: &BlueprintOpts,
) -> Result<(), RecordingStreamError>
pub fn send_blueprint_opts( &self, opts: &BlueprintOpts, ) -> Result<(), RecordingStreamError>
Send a [crate::blueprint::Blueprint] to configure the viewer layout.
§impl RecordingStream
impl RecordingStream
pub fn now(&self) -> TimePoint
pub fn now(&self) -> TimePoint
Returns the current time of the recording on the current thread.
pub fn set_timepoint(&self, timepoint: impl Into<TimePoint>)
pub fn set_timepoint(&self, timepoint: impl Into<TimePoint>)
Set the current time of the recording, for the current calling thread.
Used for all subsequent logging performed from this same thread, until the next call to one of the index/time setting methods.
There is no requirement of monotonicity. You can move the time backwards if you like.
See also:
pub fn set_time(
&self,
timeline: impl Into<TimelineName>,
value: impl TryInto<TimeCell>,
)
pub fn set_time( &self, timeline: impl Into<TimelineName>, value: impl TryInto<TimeCell>, )
Set the current value of one of the timelines.
Used for all subsequent logging performed from this same thread, until the next call to one of the index/time setting methods.
There is no requirement of monotonicity. You can move the time backwards if you like.
Example:
rec.set_time("frame_nr", rerun::TimeCell::from_sequence(42));
rec.set_time("duration", std::time::Duration::from_millis(123));
rec.set_time("capture_time", std::time::SystemTime::now());See also:
pub fn set_time_sequence(
&self,
timeline: impl Into<TimelineName>,
sequence: impl Into<i64>,
)
pub fn set_time_sequence( &self, timeline: impl Into<TimelineName>, sequence: impl Into<i64>, )
Set the current time of the recording, for the current calling thread.
Short for set_time(timeline, rerun::TimeCell::from_sequence(sequence)).
Used for all subsequent logging performed from this same thread, until the next call to one of the index/time setting methods.
For example: rec.set_time_sequence("frame_nr", frame_nr).
You can remove a timeline again using rec.disable_timeline("frame_nr").
There is no requirement of monotonicity. You can move the time backwards if you like.
See also:
pub fn set_duration_secs(
&self,
timeline: impl Into<TimelineName>,
secs: impl Into<f64>,
)
pub fn set_duration_secs( &self, timeline: impl Into<TimelineName>, secs: impl Into<f64>, )
Set the current time of the recording, for the current calling thread.
Short for set_time(timeline, std::time::Duration::from_secs_f64(secs))..
Used for all subsequent logging performed from this same thread, until the next call to one of the index/time setting methods.
For example: rec.set_duration_secs("time_since_start", time_offset).
You can remove a timeline again using rec.disable_timeline("time_since_start").
There is no requirement of monotonicity. You can move the time backwards if you like.
See also:
pub fn set_timestamp_secs_since_epoch(
&self,
timeline: impl Into<TimelineName>,
secs: impl Into<f64>,
)
pub fn set_timestamp_secs_since_epoch( &self, timeline: impl Into<TimelineName>, secs: impl Into<f64>, )
Set a timestamp as seconds since Unix epoch (1970-01-01 00:00:00 UTC).
Short for self.set_time(timeline, rerun::TimeCell::from_timestamp_secs_since_epoch(secs)).
Used for all subsequent logging performed from this same thread, until the next call to one of the index/time setting methods.
You can remove a timeline again using rec.disable_timeline(timeline).
There is no requirement of monotonicity. You can move the time backwards if you like.
See also:
pub fn set_timestamp_nanos_since_epoch(
&self,
timeline: impl Into<TimelineName>,
nanos: impl Into<i64>,
)
pub fn set_timestamp_nanos_since_epoch( &self, timeline: impl Into<TimelineName>, nanos: impl Into<i64>, )
Set a timestamp as nanoseconds since Unix epoch (1970-01-01 00:00:00 UTC).
Short for self.set_time(timeline, rerun::TimeCell::set_timestamp_nanos_since_epoch(secs)).
Used for all subsequent logging performed from this same thread, until the next call to one of the index/time setting methods.
You can remove a timeline again using rec.disable_timeline(timeline).
There is no requirement of monotonicity. You can move the time backwards if you like.
See also:
pub fn disable_timeline(&self, timeline: impl Into<TimelineName>)
pub fn disable_timeline(&self, timeline: impl Into<TimelineName>)
Clears out the current time of the recording for the specified timeline, for the current calling thread.
For example: rec.disable_timeline("frame"), rec.disable_timeline("sim_time").
See also:
pub fn reset_time(&self)
pub fn reset_time(&self)
Clears out the current time of the recording, for the current calling thread.
Used for all subsequent logging performed from this same thread, until the next call to one of the index/time setting methods.
For example: rec.reset_time().
See also:
Trait Implementations§
§impl Clone for RecordingStream
impl Clone for RecordingStream
§fn clone(&self) -> RecordingStream
fn clone(&self) -> RecordingStream
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more§impl Debug for RecordingStream
impl Debug for RecordingStream
Auto Trait Implementations§
impl Freeze for RecordingStream
impl !RefUnwindSafe for RecordingStream
impl Send for RecordingStream
impl Sync for RecordingStream
impl Unpin for RecordingStream
impl UnsafeUnpin for RecordingStream
impl !UnwindSafe for RecordingStream
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSend for T
impl<T> DowncastSend for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Layered].Source§impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
Source§fn lossless_try_into(self) -> Option<Dst>
fn lossless_try_into(self) -> Option<Dst>
Source§impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
Source§fn lossy_into(self) -> Dst
fn lossy_into(self) -> Dst
Source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Source§impl<T> StrictAs for T
impl<T> StrictAs for T
Source§fn strict_as<Dst>(self) -> Dstwhere
T: StrictCast<Dst>,
fn strict_as<Dst>(self) -> Dstwhere
T: StrictCast<Dst>,
Source§impl<Src, Dst> StrictCastFrom<Src> for Dstwhere
Src: StrictCast<Dst>,
impl<Src, Dst> StrictCastFrom<Src> for Dstwhere
Src: StrictCast<Dst>,
Source§fn strict_cast_from(src: Src) -> Dst
fn strict_cast_from(src: Src) -> Dst
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.