Struct seshat::Connection

pub struct Connection { /* fields omitted */ }

A Seshat database connection that can be used for reading.

Implementations

impl Connection

pub fn load_checkpoints(&self) -> Result<Vec<CrawlerCheckpoint>>

Load all the previously stored crawler checkpoints from the database.

Arguments

pub fn is_empty(&self) -> Result<bool>

Is the database empty. Returns true if the database is empty, false otherwise.

pub fn is_room_indexed(&self, room_id: &str) -> Result<bool>

Is a room already indexed.

Returns true if the database contains events from a room, false otherwise.

pub fn get_stats(&self) -> Result<DatabaseStats>

Get statistical information of the database.

pub fn load_file_events(
    &self,
    load_config: &LoadConfig
) -> Result<Vec<(String, Profile)>>

Load events that contain an mxc URL to a file.

Arguments

• load_config - Configuration deciding which events and how many of them should be loaded.

Examples

let config = LoadConfig::new("!testroom:localhost").limit(10);
let result = connection.load_file_events(&config);

Returns a list of tuples containing the serialized events and the profile of the sender at the time when the event was sent.

pub fn get_user_version(&self) -> Result<i64>

Get the user version stored in the database.

This version isn't used anywhere internally and can be set by the user to signal changes between the JSON that gets stored inside of Seshat.

pub fn set_user_version(&self, version: i64) -> Result<()>

Set the user version to the given version.

Arguments

• version - The new version that will be stored in the database.

Methods from Deref<Target = PooledConnection<SqliteConnectionManager>>

Trait Implementations

impl Deref for Connection

type Target = PooledConnection<SqliteConnectionManager>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Connection

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.