Struct Handle

pub struct Handle {
    pub rowid: i32,
    pub id: String,
    pub person_centric_id: Option<String>,
}

Represents a single row in the handle table.

Fields

rowid: i32

The unique identifier for the handle in the database

id: String

Identifier for a contact, i.e. a phone number or email address

person_centric_id: Option<String>

Field used to disambiguate divergent handles that represent the same contact

Trait Implementations

impl Cacheable for Handle

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

Generate a HashMap for looking up contacts by their IDs, collapsing duplicate contacts to the same ID String regardless of service

Example:

use imessage_database::util::dirs::default_db_path;
use imessage_database::tables::table::{Cacheable, get_connection};
use imessage_database::tables::handle::Handle;

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

type K = i32

The key type for the cache HashMap

type V = String

The value type for the cache HashMap

impl Debug for Handle

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

Formats the value using the given formatter.

impl Deduplicate for Handle

fn dedupe(duplicated_data: &HashMap<i32, Self::T>) -> HashMap<i32, i32>

Given the initial set of duplicated handles, deduplicate them

This returns a new hashmap that maps the real handle ID to a new deduplicated unique handle ID that represents a single handle for all of the deduplicate handles.

Assuming no new handles have been written to the database, deduplicated data is deterministic across runs.

Example:

use imessage_database::util::dirs::default_db_path;
use imessage_database::tables::table::{Cacheable, Deduplicate, get_connection};
use imessage_database::tables::handle::Handle;

let db_path = default_db_path();
let conn = get_connection(&db_path).unwrap();
let chatrooms = Handle::cache(&conn).unwrap();
let deduped_chatrooms = Handle::dedupe(&chatrooms);

type T = String

The type of data being deduplicated

impl Diagnostic for Handle

fn run_diagnostic(db: &Connection) -> Result<(), TableError>

Emit diagnostic data for the Handles table

Get the number of handles that are duplicated

The person_centric_id is used to map handles that represent the same contact across ids (numbers, emails, etc) and across services (iMessage, Jabber, iChat, SMS, etc)

In some databases, person_centric_id may not be available.

Example:

use imessage_database::util::dirs::default_db_path;
use imessage_database::tables::table::{Diagnostic, get_connection};
use imessage_database::tables::handle::Handle;

let db_path = default_db_path();
let conn = get_connection(&db_path).unwrap();
Handle::run_diagnostic(&conn);

impl Table for Handle

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

Deserialize a single row into Self, returning a rusqlite::Result

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

Prepare SELECT * statement

fn extract( handle: Result<Result<Self, Error>, Error>, ) -> Result<Self, TableError>

Map a rusqlite::Result<Self> into our TableError

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

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

Process all rows from the table using a callback. This is the most memory-efficient approach for large tables.

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

Get a BLOB from the table

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

Check if a BLOB exists in the table