Struct DbRoomEventFilter 

pub struct DbRoomEventFilter {
    limit: Option<i32>,
    not_rooms: Option<Vec<String>>,
    not_senders: Option<Vec<String>>,
    not_types: Option<Vec<String>>,
    rooms: Option<Vec<String>>,
    senders: Option<Vec<String>>,
    types: Option<Vec<String>>,
    contains_url: Option<bool>,
    include_redundant_members: Option<bool>,
    lazy_load_members: Option<bool>,
    unread_thread_notifications: Option<bool>,
}

Filters applied to the room events, based on which events these are used. See DbRoomFilter for more.

Fields

limit: Option<i32>

The maximum number of events returned. It should always be more than 0 and and have a reasonable maximum.

NOTE: this field should never return None, but since the type checking by sqlx does not allow for overwrite or constraint on the types, we will handle it at the application level.

not_rooms: Option<Vec<String>>

The rooms to exclude.

not_senders: Option<Vec<String>>

The senders to exclude.

not_types: Option<Vec<String>>

The event types to exclude.

rooms: Option<Vec<String>>

The rooms to include.

senders: Option<Vec<String>>

The senders to include.

types: Option<Vec<String>>

The types to include.

contains_url: Option<bool>

If it Some, it means that something events will be excluded. If it is true the events without URL will be excluded. If it is false the events with URL will be excluded.

include_redundant_members: Option<bool>

If true, sends all membership events for all events, even if they have already been sent to the client. Does not apply unless lazy_load_members is true.

lazy_load_members: Option<bool>

Lazily Load the membership events.

unread_thread_notifications: Option<bool>

Enables Per thread notification counts. Only applies to the /sync endpoint.

Trait Implementations

impl Debug for DbRoomEventFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'r> Decode<'r, Postgres> for DbRoomEventFilter

fn decode( value: PgValueRef<'r>, ) -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Decode a new value of this type using a raw value from the database.

impl<'q> Encode<'_, Postgres> for DbRoomEventFilter

fn encode_by_ref( &self, buf: &mut PgArgumentBuffer, ) -> Result<IsNull, BoxDynError>

Writes the value of self into buf without moving self.

fn size_hint(&self) -> usize

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

impl From<RoomEventFilter> for DbRoomEventFilter

fn from(filter: RoomEventFilter) -> Self

Converts to this type from the input type.

impl PgHasArrayType for DbRoomEventFilter

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl TryFrom<DbRoomEventFilter> for Filter

type Error = DatabaseError

The type returned in the event of a conversion error.

fn try_from(filter: DbRoomEventFilter) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<DbRoomEventFilter> for RoomEventFilter

type Error = DatabaseError

The type returned in the event of a conversion error.

fn try_from(room_event_filter: DbRoomEventFilter) -> Result<Self, Self::Error>

Performs the conversion.

impl Type<Postgres> for DbRoomEventFilter

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.