Skip to main content

QueryFilter

Struct QueryFilter 

Source
pub struct QueryFilter {
Show 13 fields pub rooms: Vec<String>, pub users: Vec<String>, pub content_search: Option<String>, pub content_regex: Option<Regex>, pub after_seq: Option<(String, u64)>, pub before_seq: Option<(String, u64)>, pub after_ts: Option<DateTime<Utc>>, pub before_ts: Option<DateTime<Utc>>, pub mention_user: Option<String>, pub public_only: bool, pub target_id: Option<(String, u64)>, pub limit: Option<usize>, pub ascending: bool,
}
Expand description

Filter criteria for the room query subcommand (née room poll).

Constructed by the CLI flag parser and evaluated per-message. The limit and ascending fields control result set size and ordering; they are applied externally by the caller after filtering, not inside matches.

Fields§

§rooms: Vec<String>

Only include messages from these rooms. Empty = all rooms.

§users: Vec<String>

Only include messages sent by these users. Empty = all users.

§content_search: Option<String>

Only include messages whose content contains this substring (case-sensitive).

§content_regex: Option<Regex>

Only include messages whose content matches this pre-compiled regex.

Compiled once at construction time. Callers should validate the pattern before building the filter (e.g. via Regex::new).

§after_seq: Option<(String, u64)>

Only include messages whose sequence number is strictly greater than this value. Tuple is (room_id, seq). The constraint is skipped for messages whose room_id differs from the filter room.

§before_seq: Option<(String, u64)>

Only include messages whose sequence number is strictly less than this value. Tuple is (room_id, seq). Skipped for messages from other rooms.

§after_ts: Option<DateTime<Utc>>

Only include messages with a timestamp strictly after this instant.

§before_ts: Option<DateTime<Utc>>

Only include messages with a timestamp strictly before this instant.

§mention_user: Option<String>

Only include messages that @mention this username.

§public_only: bool

Exclude DirectMessage variants (public-channel filter).

§target_id: Option<(String, u64)>

Only include the single message with this exact (room_id, seq).

When set, all other seq-based filters are ignored; the match is exact. DM privacy is still enforced externally by the caller.

§limit: Option<usize>

Maximum number of messages to return. Applied externally by the caller.

§ascending: bool

If true, return messages oldest-first. If false, newest-first. Applied externally by the caller.

Implementations§

Source§

impl QueryFilter

Source

pub fn matches(&self, msg: &Message, room_id: &str) -> bool

Returns true if msg satisfies all constraints in this filter.

room_id is the room in which msg arrived; it is used when comparing against after_seq/before_seq (which carry their own room component).

Trait Implementations§

Source§

impl Clone for QueryFilter

Source§

fn clone(&self) -> QueryFilter

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QueryFilter

Source§

fn default() -> QueryFilter

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

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

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,