Skip to main content

WalRecord

Struct WalRecord 

Source
pub struct WalRecord {
    pub header: RecordHeader,
    pub payload: Vec<u8>,
}
Expand description

A complete WAL record: header + payload.

Fields§

§header: RecordHeader§payload: Vec<u8>

Implementations§

Source§

impl WalRecord

Source

pub fn new( record_type: u32, lsn: u64, tenant_id: u64, vshard_id: u32, database_id: u64, payload: Vec<u8>, encryption_key: Option<&WalEncryptionKey>, preamble_bytes: Option<&[u8; 16]>, ) -> Result<Self>

Create a new WAL record with computed CRC32C.

If encryption_key is provided, the payload is encrypted before CRC computation. The ciphertext includes a 16-byte auth tag.

preamble_bytes — when encryption is active, the 16-byte segment preamble that was written at offset 0 of this segment file. It is concatenated with the record header bytes to form the AAD, binding the ciphertext to its segment (preamble-swap defense). Pass None for unencrypted records (the argument is ignored in that case).

database_id is stored in header bytes 34-41 (previously reserved, zero-filled). Pre-existing records with zeros decode to DatabaseId(0) (the default database), preserving backward compatibility.

Source

pub fn decrypt_payload( &self, epoch: &[u8; 4], preamble_bytes: Option<&[u8; 16]>, encryption_key: Option<&WalEncryptionKey>, ) -> Result<Vec<u8>>

Decrypt the payload if the record is encrypted.

epoch must come from the on-disk segment preamble, not from the current in-memory key. preamble_bytes must be the same 16-byte preamble that was used as part of the AAD during encryption.

Source

pub fn decrypt_payload_ring( &self, epoch: &[u8; 4], preamble_bytes: Option<&[u8; 16]>, ring: Option<&KeyRing>, ) -> Result<Vec<u8>>

Decrypt the payload using a key ring (supports dual-key rotation).

epoch must come from the on-disk segment preamble. preamble_bytes must match the preamble bytes written at the start of this segment.

Source

pub fn is_encrypted(&self) -> bool

Whether this record’s payload is encrypted.

Source

pub fn logical_record_type(&self) -> u32

Logical record type with the encryption flag stripped.

Source

pub fn verify_checksum(&self) -> Result<()>

Verify the CRC32C checksum.

Source

pub fn wire_size(&self) -> usize

Total size on disk: header + payload.

Trait Implementations§

Source§

impl Clone for WalRecord

Source§

fn clone(&self) -> WalRecord

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 WalRecord

Source§

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

Formats the value using the given formatter. Read more

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> 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