Skip to main content

LogEntry

Struct LogEntry 

Source
pub struct LogEntry {
    pub hlc: HlcTimestamp,
    pub node_id: String,
    pub table: TableId,
    pub op: WriteOp,
    pub prev_hlc: Option<HlcTimestamp>,
    pub prev_value: Option<Vec<u8>>,
    pub originator: Originator,
    pub request_id: Option<String>,
    pub interface: Option<String>,
}
Expand description

A single durable record of a committed write.

Persisted to the per-deployment TransactionLog at commit time. Both audit and replication observers consume from this log:

  • Replication tail-reads by HLC: streams new entries to peers, filtering out Originator::Replicated writes so applied- from-peer entries don’t echo back.
  • Audit range-reads by HLC + filters by table / originator / user for query responses.

Wire-stable (serde-derived) because LogEntry frames also flow across the replication network protocol between nodes.

Fields§

§hlc: HlcTimestamp

HLC timestamp assigned at commit time. Strictly greater than any previously-appended entry’s HLC on the same node.

§node_id: String

Node id of the node that PERSISTED this entry (the node that observed the commit). Both locally-originated and replication- applied writes log here, so node_id is always the local node. Distinguished from Originator::Replicated::from_node which records the conceptual writer.

§table: TableId

In-deployment table identity.

§op: WriteOp

The write operation that was committed.

§prev_hlc: Option<HlcTimestamp>

HLC of the existing record at this key prior to the write, if any. None for inserts. Used by anti-entropy to record causal predecessor relationships for the receive-side HLC-LWW comparison.

§prev_value: Option<Vec<u8>>

Raw bytes of the existing record at this key prior to the write, if the table opted into @audit(capture_state: true) and the LoggingBackend was configured with capture_before: true. None when capture was disabled OR the key didn’t exist (insert path). Decoded as JSON by audit readers to surface as AuditEntry.before.

Storage cost is significant — each captured write doubles the log entry size plus pays one extra get at write time — so this is opt-in per table via the @audit directive.

Note: encoded inline (not skip_serializing_if) because the wire format is rmp-serde tuple-positional; skipping fields breaks the decoder’s positional expectations.

§originator: Originator

Who / what initiated the write.

§request_id: Option<String>

Optional correlation id for traceability — typically the request id from the HTTP / MQTT / gRPC layer.

§interface: Option<String>

Which protocol / interface the write came in through — "rest", "graphql", "mqtt", "mcp", or "internal" for platform- originated writes. None when the originator couldn’t be determined (background tasks, startup bootstrap that didn’t set the task-local). Audit queries surface this for filtering.

Implementations§

Source§

impl LogEntry

Source

pub fn encode(&self) -> Result<Vec<u8>>

Serialize to MessagePack bytes for storage / wire.

§Errors

Returns crate::error::YetiError::Internal if encoding fails (in practice, impossible for fully-owned LogEntry values; the Result is preserved for forward-compatibility with future fields that may have encoding constraints).

Source

pub fn decode(bytes: &[u8]) -> Result<Self>

Deserialize from MessagePack bytes.

§Errors

Returns crate::error::YetiError::Internal if the input is not a valid LogEntry encoding (truncation, version skew, or corruption on disk).

Trait Implementations§

Source§

impl Clone for LogEntry

Source§

fn clone(&self) -> LogEntry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LogEntry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for LogEntry

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for LogEntry

Source§

impl PartialEq for LogEntry

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for LogEntry

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for LogEntry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more