Struct seshat::Connection

source [−]

pub struct Connection { /* private fields */ }

Expand description

A Seshat database connection that can be used for reading.

Implementations

source

impl Connection

source

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

Load all the previously stored crawler checkpoints from the database.

Arguments

source

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

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

source

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.

source

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

Get statistical information of the database.

source

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.

source

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.

source

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.

Trait Implementations

source

impl Deref for Connection

type Target = PooledConnection<SqliteConnectionManager>

The resulting type after dereferencing.

source

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

Dereferences the value.

source

impl DerefMut for Connection

source

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

Mutably dereferences the value.

Auto Trait Implementations

impl !RefUnwindSafe for Connection

impl Send for Connection

impl !Sync for Connection

impl Unpin for Connection

impl !UnwindSafe for Connection

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

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

source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> Erased for T

source

Struct seshat::Connection

Implementations

impl Connection

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

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

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

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

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

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

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

Trait Implementations

impl Deref for Connection

type Target = PooledConnection<SqliteConnectionManager>

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

impl DerefMut for Connection

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

Auto Trait Implementations

impl !RefUnwindSafe for Connection

impl Send for Connection

impl !Sync for Connection

impl Unpin for Connection

impl !UnwindSafe for Connection

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> Erased for T

impl<T> Fruit for T where T: Send + Downcast,

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> Fruit for T where
T: Send + Downcast,