Struct Sqlite3DbHeader

#[repr(C)]
pub struct Sqlite3DbHeader {

    pub header_str: [u8; 16],
    pub page_size: U16<BigEndian>,
    pub write_version: u8,
    pub read_version: u8,
    pub reserved_in_page: u8,
    pub max_payload: u8,
    pub min_payload: u8,
    pub leaf_payload: u8,
    pub change_count: U32<BigEndian>,
    pub db_size: U32<BigEndian>,
    pub freelist_pno: U32<BigEndian>,
    pub freelist_len: U32<BigEndian>,
    pub schema_cookie: U32<BigEndian>,
    pub schema_format_number: U32<BigEndian>,
    pub default_cache_size: U32<BigEndian>,
    pub largest_root: U32<BigEndian>,
    pub text_encoding: U32<BigEndian>,
    pub user_version: U32<BigEndian>,
    pub incremental_vacuum: U32<BigEndian>,
    pub app_id: U32<BigEndian>,
    pub replication_index: U64<BigEndian>,
    pub version_valid_for: U32<BigEndian>,
    pub sqlite_version: U32<BigEndian>,
    /* private fields */
}

Available on crate feature core only.

Patched database header file, in use by libsql

Fields

header_str: [u8; 16]

The header string: “SQLite format 3\000”

page_size: U16<BigEndian>

The database page size in bytes. Must be a power of two between 512 and 32768 inclusive, or the value 1 representing a page size of 65536.

write_version: u8

File format write version. 1 for legacy; 2 for WAL.

read_version: u8

File format write version. 1 for legacy; 2 for WAL.

reserved_in_page: u8

Bytes of unused “reserved” space at the end of each page. Usually 0.

max_payload: u8

Maximum embedded payload fraction. Must be 64.

min_payload: u8

Minimum embedded payload fraction. Must be 32.

leaf_payload: u8

Leaf payload fraction. Must be 32.

change_count: U32<BigEndian>

File change counter.

db_size: U32<BigEndian>

Size of the database file in pages. The “in-header database size”.

freelist_pno: U32<BigEndian>

Page number of the first freelist trunk page.

freelist_len: U32<BigEndian>

Total number of freelist pages.

schema_cookie: U32<BigEndian>

The schema cookie.

schema_format_number: U32<BigEndian>

The schema format number. Supported schema formats are 1, 2, 3, and 4.

default_cache_size: U32<BigEndian>

Default page cache size.

largest_root: U32<BigEndian>

The page number of the largest root b-tree page when in auto-vacuum or incremental-vacuum modes, or zero otherwise.

text_encoding: U32<BigEndian>

The database text encoding. A value of 1 means UTF-8. A value of 2 means UTF-16le. A value of 3 means UTF-16be.

user_version: U32<BigEndian>

The “user version” as read and set by the user_version pragma.

incremental_vacuum: U32<BigEndian>

True (non-zero) for incremental-vacuum mode. False (zero) otherwise.

app_id: U32<BigEndian>

The “Application ID” set by PRAGMA application_id.

replication_index: U64<BigEndian>

The replication index of this database, this is a libsql extension, ignored by sqlite3.

version_valid_for: U32<BigEndian>

The version-valid-for number.

sqlite_version: U32<BigEndian>

SQLITE_VERSION_NUMBER

Trait Implementations

impl AsBytes for Sqlite3DbHeader

where [u8; 16]: AsBytes, U16<BigEndian>: AsBytes, u8: AsBytes, U32<BigEndian>: AsBytes, [u8; 12]: AsBytes, U64<BigEndian>: AsBytes, HasPadding<Sqlite3DbHeader, libsql_sys::::ffi::{impl#4}::{constant#2}>: ShouldBe<false>,

fn as_bytes(&self) -> &[u8]

Gets the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to bytes.

fn write_to_prefix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the prefix of bytes.

fn write_to_suffix(&self, bytes: &mut [u8]) -> Option<()>

Writes a copy of self to the suffix of bytes.

impl Clone for Sqlite3DbHeader

fn clone(&self) -> Sqlite3DbHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sqlite3DbHeader

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

Formats the value using the given formatter.

impl FromBytes for Sqlite3DbHeader

where [u8; 16]: FromBytes, U16<BigEndian>: FromBytes, u8: FromBytes, U32<BigEndian>: FromBytes, [u8; 12]: FromBytes, U64<BigEndian>: FromBytes,

fn ref_from(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the given bytes as a &Self without copying.

fn ref_from_prefix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the prefix of the given bytes as a &Self without copying.

fn ref_from_suffix(bytes: &[u8]) -> Option<&Self>

where Self: Sized,

Interprets the suffix of the given bytes as a &Self without copying.

fn mut_from(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut Self without copying.

fn mut_from_prefix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut Self without copying.

fn mut_from_suffix(bytes: &mut [u8]) -> Option<&mut Self>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut Self without copying.

fn slice_from(bytes: &[u8]) -> Option<&[Self]>

where Self: Sized,

Interprets the given bytes as a &[Self] without copying.

fn slice_from_prefix(bytes: &[u8], count: usize) -> Option<(&[Self], &[u8])>

where Self: Sized,

Interprets the prefix of the given bytes as a &[Self] with length equal to count without copying.

fn slice_from_suffix(bytes: &[u8], count: usize) -> Option<(&[u8], &[Self])>

where Self: Sized,

Interprets the suffix of the given bytes as a &[Self] with length equal to count without copying.

fn mut_slice_from(bytes: &mut [u8]) -> Option<&mut [Self]>

where Self: Sized + AsBytes,

Interprets the given bytes as a &mut [Self] without copying.

fn mut_slice_from_prefix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [Self], &mut [u8])>

where Self: Sized + AsBytes,

Interprets the prefix of the given bytes as a &mut [Self] with length equal to count without copying.

fn mut_slice_from_suffix( bytes: &mut [u8], count: usize, ) -> Option<(&mut [u8], &mut [Self])>

where Self: Sized + AsBytes,

Interprets the suffix of the given bytes as a &mut [Self] with length equal to count without copying.

fn read_from(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from bytes.

fn read_from_prefix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the prefix of bytes.

fn read_from_suffix(bytes: &[u8]) -> Option<Self>

where Self: Sized,

Reads a copy of Self from the suffix of bytes.

impl FromZeroes for Sqlite3DbHeader

where [u8; 16]: FromZeroes, U16<BigEndian>: FromZeroes, u8: FromZeroes, U32<BigEndian>: FromZeroes, [u8; 12]: FromZeroes, U64<BigEndian>: FromZeroes,

fn zero(&mut self)

Overwrites self with zeroes.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Copy for Sqlite3DbHeader