Skip to main content

RecordHeader

Struct RecordHeader 

Source
pub struct RecordHeader {
    pub magic: u32,
    pub format_version: u16,
    pub record_type: u32,
    pub lsn: u64,
    pub tenant_id: u64,
    pub vshard_id: u32,
    pub payload_len: u32,
    pub database_id: u64,
    pub reserved: [u8; 8],
    pub crc32c: u32,
}
Expand description

WAL record header (fixed 54 bytes).

Fields§

§magic: u32§format_version: u16§record_type: u32§lsn: u64§tenant_id: u64§vshard_id: u32§payload_len: u32§database_id: u64

Database scope for this record. Stored as a raw u64; callers convert to/from DatabaseId. Pre-Tier-2 records had zeros here, so 0 maps to DatabaseId(0) (the default database) — fully backward compatible.

Occupies bytes 34–41 of the on-disk header (previously part of reserved).

§reserved: [u8; 8]

Reserved for future use; must be zero on write; ignored on read (but covered by CRC32C). Occupies bytes 42–49.

§crc32c: u32

Implementations§

Source§

impl RecordHeader

Source

pub fn to_bytes(&self) -> [u8; 54]

Source

pub fn from_bytes(buf: &[u8; 54]) -> Self

Source

pub fn compute_checksum(&self, payload: &[u8]) -> u32

CRC32C over header (excluding the crc32c field) + payload.

The 16 reserved bytes are included in the CRC so they cannot be silently modified without detection.

Source

pub fn logical_record_type(&self) -> u32

Logical record type with the encryption flag stripped.

Source

pub fn validate(&self, offset: u64) -> Result<()>

Trait Implementations§

Source§

impl Clone for RecordHeader

Source§

fn clone(&self) -> RecordHeader

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 Copy for RecordHeader

Source§

impl Debug for RecordHeader

Source§

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

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

impl Eq for RecordHeader

Source§

impl PartialEq for RecordHeader

Source§

fn eq(&self, other: &RecordHeader) -> 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 StructuralPartialEq for RecordHeader

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