Skip to main content

Store

Struct Store 

Source
pub struct Store { /* private fields */ }
Expand description

The SQLite database, and every query the server makes against it.

Implementations§

Source§

impl Store

Source

pub fn create_enrollment( &self, e: &NewEnrollment<'_>, max_pending: usize, max_per_address: usize, ) -> Result<Created>

Stores a pending enrolment, unless its code is in use by another one still waiting, max_pending are waiting already, or max_per_address from its address are.

Source

pub fn poll_enrollment( &self, enrollment_id: &str, now: OffsetDateTime, interval: Duration, ) -> Result<Poll>

Answers a machine’s poll, and records when it asked.

A poll sooner than interval after the last one is told to slow down. A second of slack keeps a client that sleeps exactly the interval from being told so because its previous request spent a moment in flight.

Source

pub fn approve_enrollment( &self, user_code: &str, device_id: &str, scope: &str, now: &str, expected_fingerprint: Option<&str>, ) -> Result<Decision<Device>>

Approves the enrolment waiting with user_code, making it device device_id. When expected_fingerprint is given, the code’s key must have exactly that fingerprint.

Source

pub fn deny_enrollment( &self, user_code: &str, now: &str, ) -> Result<Decision<String>>

Denies the enrolment waiting with user_code, answering with the name it asked for.

Source

pub fn pending_enrollment( &self, user_code: &str, now: &str, ) -> Result<Decision<Waiting>>

What the enrolment waiting with user_code asked for, judged the way approving it would be, so a lookup and the approval after it never disagree about whether the code is still good.

Source

pub fn insert_device( &self, d: &NewDevice<'_>, max_for_key: Option<u32>, ) -> Result<Inserted>

Stores a device, unless an unrevoked one has its name or, when max_for_key is given, its authkey already has that many unrevoked devices. Both are checked under the lock the insert holds.

Source

pub fn device(&self, id: &str) -> Result<Option<Device>>

One device, revoked or not.

Source

pub fn devices(&self) -> Result<Vec<Device>>

Every device, newest first.

Source

pub fn revoke_device(&self, id: &str, now: &str) -> Result<Option<Device>>

Revokes a device. Revoking one already revoked keeps the first time. None when there is no such device.

Source

pub fn touch_device(&self, id: &str, now: &str) -> Result<()>

Records that a device was just seen.

Source

pub fn insert_authkey(&self, k: &NewAuthkey<'_>) -> Result<Authkey>

Stores an authkey’s hash and details.

Source

pub fn authkey_by_hash(&self, key_sha256: &str) -> Result<Option<Authkey>>

The authkey whose SHA-256 is key_sha256, in any state.

Source

pub fn authkeys(&self) -> Result<Vec<Authkey>>

Every authkey, newest first.

Source

pub fn revoke_authkey( &self, id: &str, now: &str, devices: bool, ) -> Result<Option<Authkey>>

Revokes an authkey, keeping the first time if it already was, and with devices every device it enrolled too; without it they are untouched. None when there is no such key.

Source

pub fn sweep_devices( &self, idle_before: &str, expired_before: &str, ) -> Result<(usize, usize)>

Removes ephemeral devices last seen (or, never seen, created) before idle_before, and enrolments that expired before expired_before. Answers how many of each went.

Source§

impl Store

Source

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Opens (creating if needed) the database at path.

Source

pub fn open_in_memory() -> Result<Self>

An in-memory database, for tests.

Source

pub fn get( &self, project_key: &str, file_path: &str, ) -> Result<Option<Existing>>

Reads one row.

Source

pub fn upsert( &self, project_key: &str, file_path: &str, content: &str, source_env: &str, updated_at: &str, ) -> Result<()>

Writes content, clearing any tombstone.

Source

pub fn tombstone( &self, project_key: &str, file_path: &str, source_env: &str, updated_at: &str, ) -> Result<()>

Marks a file deleted while deliberately leaving its content in place: a mistaken delete stays recoverable at the database level, even though nothing in the app surfaces an undo yet. Store::list withholds the content so a pull can’t resurrect it.

Source

pub fn list(&self, project_key: &str) -> Result<Vec<File>>

Every file for a project, tombstones included so a pulling client knows what to remove locally — but with the deleted content withheld.

Source

pub fn last_sync_at(&self) -> Result<String>

The most recent write across all projects, for /health. Empty when nothing has ever been synced.

Source

pub fn admin_stats(&self) -> Result<(Vec<ProjectStats>, AdminTotals)>

Aggregates per project for the admin page.

Source

pub fn backup(&self, dir: impl AsRef<Path>, keep: usize) -> Result<PathBuf>

Writes a consistent snapshot via VACUUM INTO, which is safe against a live database — unlike copying the file — then prunes the oldest snapshots beyond keep.

Auto Trait Implementations§

§

impl !Freeze for Store

§

impl RefUnwindSafe for Store

§

impl Send for Store

§

impl Sync for Store

§

impl Unpin for Store

§

impl UnsafeUnpin for Store

§

impl UnwindSafe for Store

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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