Struct Chat 

pub struct Chat {
    pub rowid: i32,
    pub chat_identifier: String,
    pub service_name: Option<String>,
    pub display_name: Option<String>,
    pub is_filtered: Option<i32>,
    pub is_blackholed: Option<bool>,
    pub is_pending_review: Option<bool>,
}

Row from the chat table.

Fields

rowid: i32

Chat row ID.

chat_identifier: String

Phone number, email, or group chat identifier.

service_name: Option<String>

Service name stored for the chat.

display_name: Option<String>

User-provided chat display name.

is_filtered: Option<i32>

Raw conversation-list tier from chat.is_filtered, used to build the ChatFilterStatus via Self::filter_status.

is_blackholed: Option<bool>

Raw chat.is_blackholed flag: 1 denotes a chat whose incoming messages are silently dropped.

is_pending_review: Option<bool>

Raw chat.is_pending_review flag: 1 denotes a filtered chat awaiting review.

Implementations

impl Chat

pub fn name(&self) -> &str

Return the display name, falling back to the chat identifier.

pub fn display_name(&self) -> Option<&str>

Return the non-empty custom display name.

pub fn service(&self) -> Service<'_>

Return the chat service as a Service.

pub fn filter_status(&self) -> Option<ChatFilterStatus>

Parse the conversation-list tier from Self::is_filtered.

A raw 0 maps to ChatFilterStatus::Unfiltered. None remains None, and every unrecognized value maps to ChatFilterStatus::Unknown.

pub fn properties(&self, db: &Connection) -> Option<Properties>

Parse Properties from the chat’s plist blob.

Calling this reads a BLOB from the database.

Trait Implementations

impl Cacheable for Chat

fn cache(db: &Connection) -> Result<HashMap<Self::K, Self::V>, TableError>

Cache chat rows by row ID.

Chat row IDs can represent duplicate conversations; deduplication happens after participant handles are loaded.

Example:

use imessage_database::util::dirs::default_db_path;
use imessage_database::tables::table::{Cacheable, get_connection};
use imessage_database::tables::chat::Chat;

let db_path = default_db_path();
let conn = get_connection(&db_path).unwrap();
let chatrooms = Chat::cache(&conn);

type K = i32

Key type for the cache map.

type V = Chat

Value type for the cache map.

impl Debug for Chat

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

Formats the value using the given formatter.

impl Table for Chat

fn from_row(row: &Row<'_>) -> Result<Chat>

Deserialize a single row into Self. Returns rusqlite::Result for direct use inside rusqlite::query_map / query_row callbacks. For high-level iteration, prefer Table::rows or Table::row.

fn get(db: &Connection) -> Result<CachedStatement<'_>, TableError>

Prepare the table’s default SELECT * statement.

fn rows<'stmt, P: Params>( stmt: &'stmt mut Statement<'_>, params: P, ) -> Result<impl Iterator<Item = Result<Self, TableError>> + 'stmt, TableError>

where Self: 'stmt,

Iterate over rows produced by stmt. The default implementation deserializes each through from_row. Row-fetch and row-deserialization failures are surfaced uniformly as TableError. Accepts both rusqlite::Statement and rusqlite::CachedStatement (the latter via deref coercion).

fn row<P: Params>( stmt: &mut Statement<'_>, params: P, ) -> Result<Self, TableError>

Fetch exactly one row from stmt. Returns TableError::QueryError if the row is missing or fails to deserialize. Accepts both rusqlite::Statement and rusqlite::CachedStatement (the latter via deref coercion).

fn stream<F, E>(db: &Connection, callback: F) -> Result<(), E>

where E: From<TableError>, F: FnMut(Result<Self, TableError>) -> Result<(), E>,

Process every row from the table’s default SELECT * query using a callback. Builds and discards the prepared statement internally, so the caller never sees it.

fn get_blob<'a>( &self, db: &'a Connection, table: &str, column: &str, rowid: i64, ) -> Option<Blob<'a>>

Open a BLOB column for the supplied rowid.

fn has_blob( &self, db: &Connection, table: &str, column: &str, rowid: i64, ) -> bool

Return whether a BLOB column is non-null for the supplied rowid.