Enum LogMsg 

pub enum LogMsg {
    SetStoreInfo(SetStoreInfo),
    ArrowMsg(StoreId, ArrowMsg),
    BlueprintActivationCommand(BlueprintActivationCommand),
}

The most general log message sent from the SDK to the server.

Note: this does not contain tables sent via TableMsg, as these concepts are fundamentally different and should not be handled uniformly. For example, we don’t want to store tables in .rrd files.

Variants

SetStoreInfo(SetStoreInfo)

A new recording has begun.

Should usually be the first message sent.

ArrowMsg(StoreId, ArrowMsg)

Log an entity using an ArrowMsg.

BlueprintActivationCommand(BlueprintActivationCommand)

Send after all messages in a blueprint to signal that the blueprint is complete.

This is so that the viewer can wait with activating the blueprint until it is fully transmitted. Showing a half-transmitted blueprint can cause confusion, and also lead to problems with view heuristics.

Implementations

impl LogMsg

pub fn store_id(&self) -> &StoreId

pub fn set_store_id(&mut self, new_store_id: StoreId)

pub fn arrow_record_batch_mut(&mut self) -> Option<&mut RecordBatch>

If we are an ArrowMsg, return a mutable reference to the underlying ArrowRecordBatch.

pub fn insert_arrow_record_batch_metadata(&mut self, key: String, value: String)

Trait Implementations

impl Clone for LogMsg

fn clone(&self) -> LogMsg

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LogMsg

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

Formats the value using the given formatter.

impl DecoderEntrypoint for LogMsg

fn decode( data_excluding_headers: Bytes, byte_span_excluding_headers: Span<u64>, message_kind: MessageKind, app_id_injector: &mut impl ApplicationIdInjector, patched_version: Option<CrateVersion>, ) -> Result<Option<LogMsg>, CodecError>

impl From<BlueprintActivationCommand> for LogMsg

fn from(value: BlueprintActivationCommand) -> LogMsg

Converts to this type from the input type.

impl From<SetStoreInfo> for LogMsg

fn from(value: SetStoreInfo) -> LogMsg

Converts to this type from the input type.

impl PartialEq for LogMsg

fn eq(&self, other: &LogMsg) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for LogMsg

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl ToTransport for LogMsg

type Output = Msg

type Context<'a> = Compression

fn to_transport( &self, compression: <LogMsg as ToTransport>::Context<'_>, ) -> Result<<LogMsg as ToTransport>::Output, CodecError>

impl StructuralPartialEq for LogMsg