Struct CovenReadHandle 

pub struct CovenReadHandle { /* private fields */ }

A handle that reads synced rows and maintains its local file cache (§4, E1). Its shared store lock prevents deletion until all its connections close. Its SQL may not read coven_sync_status: it can’t tell whether the writer that last wrote the row still runs (E5).

async fn no_writes(handle: &coven::CovenReadHandle) {
    handle.write(|_| Ok::<_, coven::CovenError>(())).await;
}

fn no_live_query(handle: &coven::CovenReadHandle) {
    handle.subscribe(|_| Ok::<_, coven::CovenError>(()));
}

Implementations

impl CovenReadHandle

pub async fn store_name(&self) -> CovenResult<String>

The store’s current name from this device’s committed state (E9).

pub fn read<F, R, E>(&self, read: F) -> Read<'_, F, ReadOnly>

where F: FnOnce(SqlReadContext<'_>) -> Result<R, E> + Send + 'static, R: Send + 'static, E: From<DbError> + CarriesBug + Send + 'static,

A read of one consistent snapshot, run when awaited.

pub async fn sqlite_settings(&self) -> Result<SqliteSettingsInEffect, DbError>

The SQLite settings this handle’s connections have in effect (§4).

pub async fn file_ref(&self, file: FileId) -> Result<FileRef, DbError>

The file a row references, by the id the row holds.

pub async fn user_file(&self, file: FileId) -> Result<Option<UserFile>, DbError>

The path, size and modification time recorded for a file’s original.

pub async fn read_file(&self, file: &FileRef) -> Result<Vec<u8>, FileReadError>

Reads a whole file. A stored file is checked against its content hash.

pub async fn open_file_stream( &self, file: &FileRef, ) -> Result<FileStream<ReadOnly>, FileReadError>

Opens a file for reading ranges (§17.7), as its record stands when it opens; keep the stream for as long as the file is read. Its shared store lock prevents deletion until it and its I/O finish.

pub async fn close(&self) -> Result<(), DbError>

Closes read and cache connections on all clones and releases their storage client and shared store lock, while the app still holds the handle. From its first poll every clone refuses new calls with StoreClosed; the closing itself runs as its own task, so dropping this future doesn’t stop it (E1, E15). File streams retain their own locks.

Trait Implementations

impl Clone for CovenReadHandle

fn clone(&self) -> CovenReadHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.