Struct QueryContext 

pub struct QueryContext {
    pub start: Option<i64>,
    pub end: Option<i64>,
    pub selected_handle_ids: Option<BTreeSet<i32>>,
    pub selected_chat_ids: Option<BTreeSet<i32>>,
}

Filters applied to message count and stream queries.

Fields

start: Option<i64>

Inclusive lower-bound timestamp for message dates.

end: Option<i64>

Inclusive upper-bound timestamp for message dates.

selected_handle_ids: Option<BTreeSet<i32>>

Handle row IDs included in the query.

selected_chat_ids: Option<BTreeSet<i32>>

Chat row IDs included in the query.

Implementations

impl QueryContext

pub fn set_start(&mut self, start: &str) -> Result<(), QueryContextError>

Set the inclusive lower-bound date from YYYY-MM-DD.

Example:

use imessage_database::util::query_context::QueryContext;

let mut context = QueryContext::default();
context.set_start("2023-01-01");

pub fn set_end(&mut self, end: &str) -> Result<(), QueryContextError>

Set the inclusive upper-bound date from YYYY-MM-DD.

Example:

use imessage_database::util::query_context::QueryContext;

let mut context = QueryContext::default();
context.set_end("2023-01-01");

pub fn set_selected_handle_ids(&mut self, selected_handle_ids: BTreeSet<i32>)

Set the handle row IDs included in the query.

Example:

use std::collections::BTreeSet;
use imessage_database::util::query_context::QueryContext;

let mut context = QueryContext::default();
context.set_selected_handle_ids(BTreeSet::from([1, 2, 3]));

pub fn set_selected_chat_ids(&mut self, selected_chat_ids: BTreeSet<i32>)

Set the chat row IDs included in the query.

Example:

use std::collections::BTreeSet;
use imessage_database::util::query_context::QueryContext;

let mut context = QueryContext::default();
context.set_selected_chat_ids(BTreeSet::from([1, 2, 3]));

pub fn has_filters(&self) -> bool

true when any filter is set.

Example:

use imessage_database::util::query_context::QueryContext;

let mut context = QueryContext::default();
assert!(!context.has_filters());
context.set_start("2023-01-01");
assert!(context.has_filters());

Trait Implementations

impl Debug for QueryContext

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

Formats the value using the given formatter.

impl Default for QueryContext

fn default() -> QueryContext

Returns the “default value” for a type.

impl Eq for QueryContext

impl PartialEq for QueryContext

fn eq(&self, other: &QueryContext) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QueryContext