sqlite-rs 0.3.7

SQLite reader in pure Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use crate::traits::{Name, ParseBytes};
use crate::{
  field_parsing_error, impl_name,
  result::{SqliteError, SqliteResult},
};

/// # Schema format number (4 Bytes)
///
///  The schema format number is a 4-byte big-endian integer at offset 44. The
/// schema format number is similar to the file format read and write version
/// numbers at offsets 18 and 19 except that the schema format number refers to
/// the high-level SQL formatting rather than the low-level b-tree formatting.
/// Four schema format numbers are currently defined:
///
/// - Format 1 is understood by all versions of Sqlite back to version 3.0.0
///   (2004-06-18).
///
/// - Format 2 adds the ability of rows within the same table to have a varying
///   number of columns, in order to support the ALTER TABLE ... ADD COLUMN
///   functionality. Support for reading and writing format 2 was added in
///   Sqlite version 3.1.3 on 2005-02-20.
///
/// - Format 3 adds the ability of extra columns added by
///   ALTER TABLE ... ADD COLUMN to have non-NULL default values. This
///   capability was added in Sqlite version 3.1.4 on 2005-03-11.
///
/// - Format 4 causes Sqlite to respect the DESC keyword on index declarations.
///   (The DESC keyword is ignored in indexes for formats 1, 2, and 3.) Format 4
///   also adds two new boolean record type values (serial types 8 and 9).
///   Support for format 4 was added in Sqlite 3.3.0 on 2006-01-10.
///
///  New database files created by Sqlite use format 4 by default. The
/// legacy_file_format pragma can be used to cause Sqlite to create new database
/// files using format 1. The format version number can be made to default to 1
/// instead of 4 by setting SQLITE_DEFAULT_FILE_FORMAT=1 at compile-time.
#[derive(Debug, Default, PartialEq, Eq)]
pub enum SchemaFormat {
  Format1,
  Format2,
  Format3,
  #[default]
  Format4,
}

impl TryFrom<u32> for SchemaFormat {
  type Error = SqliteError;

  fn try_from(value: u32) -> Result<Self, Self::Error> {
    match value {
      1 => Ok(Self::Format1),
      2 => Ok(Self::Format2),
      3 => Ok(Self::Format3),
      4 => Ok(Self::Format4),
      _ => Err(field_parsing_error! {Self::NAME.into()}),
    }
  }
}

impl From<&SchemaFormat> for u32 {
  fn from(value: &SchemaFormat) -> Self {
    match value {
      SchemaFormat::Format1 => 1,
      SchemaFormat::Format2 => 2,
      SchemaFormat::Format3 => 3,
      SchemaFormat::Format4 => 4,
    }
  }
}

impl_name! {SchemaFormat}

impl ParseBytes for SchemaFormat {
  const LENGTH_BYTES: usize = 4;

  fn parsing_handler(bytes: &[u8]) -> SqliteResult<Self> {
    let buf: [u8; Self::LENGTH_BYTES] = bytes.try_into()?;

    let value = u32::from_be_bytes(buf);

    value.try_into()
  }
}