cartel-sqlite 0.26.0

SQLite driver for the dope runtime
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use crate::{database, runtime, sys};
use std::{mem, num, path};

mod opening;

#[derive(Clone, Copy, PartialEq, Eq)]
pub enum Journal {
    Rollback,
    Wal(Wal),
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Wal {
    checkpoint: Checkpoint,
    retained_bytes: Option<u64>,
}

impl Wal {
    pub const fn new() -> Self {
        Self {
            checkpoint: Checkpoint::Auto,
            retained_bytes: None,
        }
    }

    pub const fn checkpoint(&mut self, mode: Checkpoint) -> &mut Self {
        self.checkpoint = mode;
        self
    }

    pub const fn retain(&mut self, bytes: Option<u64>) -> &mut Self {
        self.retained_bytes = bytes;
        self
    }
}

impl Default for Wal {
    fn default() -> Self {
        Self::new()
    }
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub enum Checkpoint {
    Auto,
    Pages(num::NonZero<u32>),
    Manual,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub enum Synchronous {
    Off,
    Normal,
    Full,
    Extra,
}

impl Synchronous {
    const fn value(self) -> i32 {
        match self {
            Self::Off => 0,
            Self::Normal => 1,
            Self::Full => 2,
            Self::Extra => 3,
        }
    }
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub enum Access {
    Read,
    Write,
    Create,
}

#[derive(Clone, Copy, PartialEq, Eq)]
pub struct OpenOptions {
    access: Access,
    journal: Journal,
    synchronous: Synchronous,
    mapped_bytes: u64,
    path_bytes: usize,
}

impl OpenOptions {
    const PATH_BYTES: usize = 4096;

    pub const fn new() -> Self {
        Self {
            access: Access::Create,
            journal: Journal::Rollback,
            synchronous: Synchronous::Full,
            mapped_bytes: 0,
            path_bytes: Self::PATH_BYTES,
        }
    }

    pub const fn access(&mut self, access: Access) -> &mut Self {
        self.access = access;
        self
    }

    pub const fn journal(&mut self, journal: Journal) -> &mut Self {
        self.journal = journal;
        self
    }

    pub const fn synchronous(&mut self, mode: Synchronous) -> &mut Self {
        self.synchronous = mode;
        self
    }

    pub const fn mapped_bytes(&mut self, bytes: u64) -> &mut Self {
        self.mapped_bytes = bytes;
        self
    }

    pub const fn path_bytes(&mut self, bytes: usize) -> &mut Self {
        self.path_bytes = bytes;
        self
    }

    pub fn open<'sql>(
        &self,
        runtime: runtime::Runtime,
        path: impl AsRef<path::Path>,
    ) -> Result<database::Target<'sql>, crate::Error> {
        let path = path.as_ref();
        let path = sys::Filename::new(path, self.path_bytes)?;
        Ok(database::Target::new(
            runtime,
            database::Location::File(path),
            *self,
        ))
    }

    pub fn open_memory<'sql>(
        &self,
        runtime: runtime::Runtime,
    ) -> Result<database::Target<'sql>, crate::Error> {
        match self.journal {
            Journal::Rollback => {}
            Journal::Wal(_) => return Err(crate::Error::MemoryJournal),
        }
        Ok(database::Target::new(
            runtime,
            database::Location::Memory,
            *self,
        ))
    }

    pub(crate) const fn flags(self) -> i32 {
        match self.access {
            Access::Read => libsqlite3_sys::SQLITE_OPEN_READONLY,
            Access::Write => libsqlite3_sys::SQLITE_OPEN_READWRITE,
            Access::Create => {
                libsqlite3_sys::SQLITE_OPEN_READWRITE | libsqlite3_sys::SQLITE_OPEN_CREATE
            }
        }
    }
}

impl Default for OpenOptions {
    fn default() -> Self {
        Self::new()
    }
}

const _: () = {
    assert!(mem::size_of::<Access>() == 1);
    assert!(mem::size_of::<OpenOptions>() == 6 * mem::size_of::<usize>());
};