Struct re_sdk::sink::BinaryStreamSink

pub struct BinaryStreamSink {
    tx: Mutex<Sender<Option<Command>>>,
    join_handle: Option<JoinHandle<()>>,
}

Stream log messages to an in-memory binary stream.

The contents of this stream are encoded in the Rerun Record Data format (rrd).

This stream has no mechanism of limiting memory or creating back-pressure. If you do not read from it, it will buffer all messages that you have logged.

Fields

tx: Mutex<Sender<Option<Command>>>

The sender to the encoder thread.

join_handle: Option<JoinHandle<()>>

Handle to join the encoder thread on drop.

Implementations

impl BinaryStreamSink

pub fn new( rec: RecordingStream ) -> Result<(Self, BinaryStreamStorage), BinaryStreamSinkError>

Create a pair of a new BinaryStreamSink and the associated BinaryStreamStorage.

Trait Implementations

impl Drop for BinaryStreamSink

fn drop(&mut self)

Executes the destructor for this type.

impl LogSink for BinaryStreamSink

fn send(&self, msg: LogMsg)

Send this log message.

fn flush_blocking(&self)

Blocks until all pending data in the sink’s send buffers has been fully flushed.

fn send_all(&self, messages: Vec<LogMsg>)

Send all these log messages.

fn drain_backlog(&self) -> Vec<LogMsg>

Drain all buffered LogMsges and return them.

fn drop_if_disconnected(&self)

Drops all pending data currently sitting in the sink’s send buffers if it is unable to flush it for any reason (e.g. a broken TCP connection for a TcpSink).

fn send_blueprint( &self, blueprint: Vec<LogMsg>, activation_cmd: BlueprintActivationCommand )

Send a blueprint directly to the log-sink.