imessage-database

https://docs.rs/imessage-database/latest/imessage_database/
Admin
A Rust library that provides interfaces to interact with iMessage databases, enabling parsing and...
Tokens:105,524
Snippets:1,704
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example NSKeyedArchiver Input and Output

Source: https://docs.rs/imessage-database/latest/imessage_database/util/plist/fn.parse_ns_keyed_archiver.html?search=std%3A%3Avec

An example showing the transformation of a UID-referenced array into a resolved dictionary.

```xml
<array>
    <dict>
        <key>link</key>
        <dict>
             <key>CF$UID</key>
             <integer>2</integer>
        </dict>
    </dict>
    <string>https://chrissardegna.com</string>
</array>
```

```json
{
    link: https://chrissardegna.com
}
```

--------------------------------

### Example XML Input for NSKeyedArchiver

Source: https://docs.rs/imessage-database/latest/imessage_database/util/plist/fn.parse_ns_keyed_archiver.html

An example of XML structure representing an NSKeyedArchiver object with UID references.

```xml
<array>
    <dict>
        <key>link</key>
        <dict>
             <key>CF$UID</key>
             <integer>2</integer>
        </dict>
    </dict>
    <string>https://chrissardegna.com</string>
</array>
```

--------------------------------

### Example Message Text

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/messages/models/struct.AttributedRange.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

A simple string example used to demonstrate how message text is parsed into ranges.

```rust
let message_text = "What's up, Christopher?";
```

--------------------------------

### Run Attachment Diagnostics

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/attachment/struct.Attachment.html?search=

Example demonstrating how to execute a diagnostic check on the attachment table using the default database path.

```rust
use imessage_database::util::{dirs::default_db_path, platform::Platform};
use imessage_database::tables::table::get_connection;
use imessage_database::tables::attachment::Attachment;

let db_path = default_db_path();
let conn = get_connection(&db_path).unwrap();
Attachment::run_diagnostic(&conn, &db_path, &Platform::macOS, None);
```

--------------------------------

### Sample message text with attachment placeholder

Source: https://docs.rs/imessage-database/latest/imessage_database/util/streamtyped/fn.parse.html

An example of how message text appears when it contains an attachment placeholder.

```rust
let message_text = "\u{FFFC}Check out this photo!";
```

--------------------------------

### Cache Structure Example

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/messages/message/struct.Message.html

Represents the structure of the map returned by the cache method, mapping target message GUIDs to their associated message components.

```json
{
    "message_guid": {
        0: [Message, Message],
        1: [Message]
    }
}
```

--------------------------------

### Fallback body components

Source: https://docs.rs/imessage-database/latest/imessage_database/util/streamtyped/fn.parse.html

Example of how body components are structured for messages with attachments.

```rust
use imessage_database::message_types::text_effects::text_effect::TextEffect;
use imessage_database::tables::messages::{models::{AttributedRange, BubbleComponent, AttachmentMeta}};

let result = vec![
    BubbleComponent::Run(vec![AttributedRange::attachment(0, 3, AttachmentMeta::default())]),
    BubbleComponent::Run(vec![AttributedRange::text(3, 24, vec![TextEffect::Default])]),
];
```

--------------------------------

### Parsed Dictionary Output

Source: https://docs.rs/imessage-database/latest/imessage_database/util/plist/fn.parse_ns_keyed_archiver.html

The resulting dictionary structure after resolving UID references from the example input.

```json
{
    link: https://chrissardegna.com
}
```

--------------------------------

### Streaming Table Rows

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/trait.Table.html?search=

Example of using the stream method to process every row in a table via a callback function.

```rust
use imessage_database::{
   error::table::TableError,
   tables::{
       table::{get_connection, Table},
       handle::Handle,
   },
   util::dirs::default_db_path
};

let db_path = default_db_path();
let db = get_connection(&db_path).unwrap();

// Stream the Handle table, processing each row with a callback
Handle::stream(&db, |handle_result| {
    match handle_result {
        Ok(handle) => println!("Handle: {}", handle.id),
        Err(e) => eprintln!("Error: {:?}", e),
    }
    Ok::<(), TableError>(())
}).unwrap();
```

--------------------------------

### Concatenate Strings

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/polls/type.PollOptionID.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Examples of concatenating strings using the + operator.

```rust
let a = String::from("hello");
let b = String::from(" world");
let c = a + &b;
// `a` is moved and can no longer be used here.
```

```rust
let a = String::from("hello");
let b = String::from(" world");
let c = a.clone() + &b;
// `a` is still valid here.
```

```rust
let a = "hello";
let b = " world";
let c = a.to_string() + b;
```

--------------------------------

### pub fn home() -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.home.html

Returns the current user's home directory.

```APIDOC
## Function: home

### Description
Returns the current user's home directory as a `String`.

### Signature
`pub fn home() -> String`

### Example
```rust
use imessage_database::util::dirs::home;

let path = home();
println!("{path}");
```
```

--------------------------------

### pub fn home() -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.home.html?search=std%3A%3Avec

Returns the current user's home directory.

```APIDOC
## Function: home

### Description
Returns the current user's home directory as a String.

### Signature
`pub fn home() -> String`

### Example
```rust
use imessage_database::util::dirs::home;

let path = home();
println!("{path}");
```
```

--------------------------------

### Query a Message by GUID

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/messages/message/struct.Message.html

Retrieves a single message record from the database using its unique GUID and parses its body content.

```rust
use imessage_database::{
    tables::{
        messages::Message,
        table::get_connection,
    },
    util::dirs::default_db_path,
};

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

if let Ok(mut message) = Message::from_guid("example-guid", &conn) {
    if let Ok(body) = message.parse_body(&conn) {
        message.apply_body(body);
    }
    println!("{:#?}", message)
}
```

--------------------------------

### Get string capacity

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/polls/type.PollOptionID.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the current capacity of the String in bytes.

```rust
let s = String::with_capacity(10);

assert!(s.capacity() >= 10);
```

--------------------------------

### home()

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.home.html?search=

Returns the current user's home directory as a String.

```APIDOC
## fn home()

### Description
Returns the current user's home directory.

### Signature
`pub fn home() -> String`

### Example
```rust
use imessage_database::util::dirs::home;

let path = home();
println!("{path}");
```
```

--------------------------------

### Table::get Method

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/trait.Table.html?search=std%3A%3Avec

Prepares the default SELECT * statement for the table.

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

--------------------------------

### Example streamtyped data

Source: https://docs.rs/imessage-database/latest/imessage_database/util/streamtyped/fn.parse.html

A representation of what an attributedBody typedstream blob looks like.

```text
streamtyped@NSAttributedStringNSObjectNSString+Example message  iI NSDictionaryi__kIMMessagePartAttributeNameNSNumberNSValue*
```

--------------------------------

### Get Database Connection

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/fn.get_connection.html?search=u32+-%3E+bool

Opens the Messages SQLite database in read-only mode.

```rust
pub fn get_connection(path: &Path) -> Result<Connection, TableError>
```

```rust
use imessage_database::{
    util::dirs::default_db_path,
    tables::table::get_connection
};

let db_path = default_db_path();
let connection = get_connection(&db_path);
```

--------------------------------

### home()

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.home.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieves the current user's home directory.

```APIDOC
## Function: home()

### Description
Returns the current user's home directory as a String.

### Signature
`pub fn home() -> String`

### Example
```rust
use imessage_database::util::dirs::home;

let path = home();
println!("{path}");
```
```

--------------------------------

### Retrieve Home Directory

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.home.html?search=

Returns the current user's home directory as a String.

```rust
pub fn home() -> String
```

```rust
use imessage_database::util::dirs::home;

let path = home();
println!("{path}");
```

--------------------------------

### Message::from_guid

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/messages/message/struct.Message.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Queries a single message record from the database using its unique GUID.

```APIDOC
## Message::from_guid

### Description
Queries a single message by its unique GUID identifier.

### Signature
`pub fn from_guid(guid: &str, db: &Connection) -> Result<Self, TableError>`

### Parameters
- **guid** (&str) - The unique identifier of the message.
- **db** (&Connection) - The active database connection.

### Returns
- **Result<Self, TableError>** - Returns the Message instance if found, or a TableError.
```

--------------------------------

### QuickReply Struct Definition

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/business_chat/struct.QuickReply.html

The structure definition for Apple Business Chat quick replies.

```rust
pub struct QuickReply {
    pub summary: Option<String>,
    pub options: Vec<QuickReplyOption>,
    pub selected_index: Option<usize>,
}
```

--------------------------------

### Cache Chat Rows

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/chat/struct.Chat.html?search=std%3A%3Avec

Example of caching chat rows from the database using the Cacheable trait.

```rust
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);
```

--------------------------------

### QuickReplyOption Struct Definition

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/business_chat/struct.QuickReplyOption.html

The structure definition for a quick reply option, containing a title field.

```rust
pub struct QuickReplyOption {
    pub title: String,
}
```

--------------------------------

### fn cache

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/trait.Cacheable.html?search=u32+-%3E+bool

Builds the cache from the database connection.

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

### Description
Builds the cache from the database. This method is required for any type implementing the Cacheable trait.

### Parameters
- **db** (&Connection) - Required - A reference to the database connection.

### Returns
- **Result<HashMap<Self::K, Self::V>, TableError>** - A Result containing a HashMap of the cached data or a TableError if the operation fails.
```

--------------------------------

### Map Animation from ID

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/text_effects/animation/enum.Animation.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Example usage of the from_id method to convert an integer identifier into an Animation variant.

```rust
use imessage_database::message_types::text_effects::animation::Animation;

assert_eq!(Animation::from_id(5), Animation::Big);
assert_eq!(Animation::from_id(42), Animation::Unknown(42));
```

--------------------------------

### Create a String with capacity

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/polls/type.PollOptionID.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes a String with a pre-allocated buffer to avoid reallocations during growth.

```rust
let mut s = String::with_capacity(10);

// The String contains no chars, even though it has capacity for more
assert_eq!(s.len(), 0);

// These are all done without reallocating...
let cap = s.capacity();
for _ in 0..10 {
    s.push('a');
}

assert_eq!(s.capacity(), cap);

// ...but this may make the string reallocate
s.push('a');
```

--------------------------------

### EditedEvent Struct Definition

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/edited/struct.EditedEvent.html

The structure definition for EditedEvent, containing the fields for date, text, components, and guid.

```rust
pub struct EditedEvent {
    pub date: i64,
    pub text: String,
    pub components: Vec<BubbleComponent>,
    pub guid: Option<String>,
}
```

--------------------------------

### Retrieve default database path

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.default_db_path.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns a PathBuf representing the standard location of the iMessage database on macOS.

```rust
pub fn default_db_path() -> PathBuf
```

```rust
use imessage_database::util::dirs::default_db_path;

let path = default_db_path();
println!("{path:?}");
```

--------------------------------

### Create an empty String

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/polls/type.PollOptionID.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initializes a new empty String without pre-allocating memory.

```rust
let s = String::new();
```

--------------------------------

### Handle fallback body components

Source: https://docs.rs/imessage-database/latest/imessage_database/util/streamtyped/fn.parse.html?search=u32+-%3E+bool

Demonstrates how to handle message text containing attachments or app messages.

```rust
let message_text = "\u{FFFC}Check out this photo!";
```

```rust
use imessage_database::message_types::text_effects::text_effect::TextEffect;
use imessage_database::tables::messages::{models::{AttributedRange, BubbleComponent, AttachmentMeta}};

let result = vec![
    BubbleComponent::Run(vec![AttributedRange::attachment(0, 3, AttachmentMeta::default())]),
    BubbleComponent::Run(vec![AttributedRange::text(3, 24, vec![TextEffect::Default])]),
];
```

--------------------------------

### Get chat lookup map

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/chat_handle/struct.ChatToHandle.html?search=

Load the canonical chat map used for deduplicating chat IDs across services.

```rust
use imessage_database::util::dirs::default_db_path;
use imessage_database::tables::table::get_connection;
use imessage_database::tables::chat_handle::ChatToHandle;

let db_path = default_db_path();
let conn = get_connection(&db_path).unwrap();
ChatToHandle::get_chat_lookup_map(&conn);
```

--------------------------------

### DigitalTouchMessage Implementation Methods

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/digital_touch/models/enum.DigitalTouchMessage.html?search=

Methods for parsing raw payloads and rendering Digital Touch messages.

```rust
pub fn from_payload(payload: &[u8]) -> Result<Self, DigitalTouchError>
```

```rust
pub fn render_svg(&self, backdrop: Option<ImageBackdrop<'_>>) -> String
```

```rust
pub fn render_text(&self) -> String
```

--------------------------------

### format(date: &DateTime<Local>) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.format.html

Formats a local timestamp for export output.

```APIDOC
## format

### Description
Formats a local timestamp for export output.

### Signature
`pub fn format(date: &DateTime<Local>) -> String`

### Parameters
- **date** (&DateTime<Local>) - Required - The local date-time object to format.

### Example
```rust
use chrono::offset::Local;
use imessage_database::util::dates::format;

let date = format(&Local::now());
println!("{date}");
```
```

--------------------------------

### readable_diff(start: i64, end: i64) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/index.html

Formats the elapsed time between two local timestamps into a readable string.

```APIDOC
## readable_diff

### Description
Format the elapsed time between two local timestamps.

### Signature
`pub fn readable_diff(start: i64, end: i64) -> String`
```

--------------------------------

### readable_diff(start: &DateTime<Local>, end: &DateTime<Local>) -> Option<String>

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.readable_diff.html?search=

Formats the elapsed time between two local timestamps into a string representation.

```APIDOC
## Function: readable_diff

### Description
Formats the elapsed time between two local timestamps into a human-readable string (e.g., "5 minutes, 2 seconds").

### Signature
`pub fn readable_diff(start: &DateTime<Local>, end: &DateTime<Local>) -> Option<String>`

### Parameters
- **start** (&DateTime<Local>) - The starting timestamp.
- **end** (&DateTime<Local>) - The ending timestamp.

### Returns
- **Option<String>** - A formatted string representing the duration if successful, or None.

### Example
```rust
use chrono::prelude::*;
use imessage_database::util::dates::readable_diff;

let start = Local.with_ymd_and_hms(2020, 5, 20, 9, 10, 11).unwrap();
let end = Local.with_ymd_and_hms(2020, 5, 20, 9, 15, 13).unwrap();
println!("{}", readable_diff(&start, &end).unwrap()); // "5 minutes, 2 seconds"
```
```

--------------------------------

### format(date: &DateTime<Local>) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.format.html?search=std%3A%3Avec

Formats a local timestamp for export output.

```APIDOC
## Function: format

### Description
Formats a local timestamp for export output.

### Signature
`pub fn format(date: &DateTime<Local>) -> String`

### Parameters
- **date** (&DateTime<Local>) - Required - The local timestamp to format.

### Returns
- **String** - The formatted date string.

### Example
```rust
use chrono::offset::Local;
use imessage_database::util::dates::format;

let date = format(&Local::now());
println!("{date}");
```
```

--------------------------------

### format(date: &DateTime<Local>) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.format.html?search=

Formats a local timestamp for export output.

```APIDOC
## Function: format

### Description
Formats a local timestamp for export output.

### Signature
`pub fn format(date: &DateTime<Local>) -> String`

### Parameters
- **date** (&DateTime<Local>) - The local timestamp to be formatted.

### Returns
- **String** - The formatted date string.

### Example
```rust
use chrono::offset::Local;
use imessage_database::util::dates::format;

let date = format(&Local::now());
println!("{date}");
```
```

--------------------------------

### readable_diff(start: &DateTime<Local>, end: &DateTime<Local>) -> Option<String>

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.readable_diff.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Formats the elapsed time between two local timestamps into a human-readable string.

```APIDOC
## Function: readable_diff

### Description
Calculates the difference between two `DateTime<Local>` timestamps and returns a formatted string representing the elapsed time (e.g., "5 minutes, 2 seconds"). Returns `None` if the duration cannot be formatted.

### Signature
`pub fn readable_diff(start: &DateTime<Local>, end: &DateTime<Local>) -> Option<String>`

### Parameters
- **start** (&DateTime<Local>) - The starting timestamp.
- **end** (&DateTime<Local>) - The ending timestamp.

### Example
```rust
use chrono::prelude::*;
use imessage_database::util::dates::readable_diff;

let start = Local.with_ymd_and_hms(2020, 5, 20, 9, 10, 11).unwrap();
let end = Local.with_ymd_and_hms(2020, 5, 20, 9, 15, 13).unwrap();
println!("{}", readable_diff(&start, &end).unwrap()); // "5 minutes, 2 seconds"
```
```

--------------------------------

### format(date: &DateTime<Local>) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.format.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Formats a local timestamp for export output.

```APIDOC
## Function: format

### Description
Formats a local timestamp for export output.

### Signature
`pub fn format(date: &DateTime<Local>) -> String`

### Parameters
- **date** (&DateTime<Local>) - Required - The local date-time object to be formatted.

### Returns
- **String** - The formatted date string.

### Example
```rust
use chrono::offset::Local;
use imessage_database::util::dates::format;

let date = format(&Local::now());
println!("{date}");
```
```

--------------------------------

### parse_ns_keyed_archiver

Source: https://docs.rs/imessage-database/latest/imessage_database/util/plist/fn.parse_ns_keyed_archiver.html

Deserializes an NSKeyedArchiver property list by resolving UID references. The function walks the references in the $objects array starting from $top.root to return the reconstructed value.

```APIDOC
## Function: parse_ns_keyed_archiver

### Signature
`pub fn parse_ns_keyed_archiver(plist: &Value) -> Result<Value, PlistParseError>`

### Description
Deserializes an `NSKeyedArchiver` property list by resolving UID references. The archive stores objects in `$objects` and points `$top.root` at the root object. This function walks those references and returns the reconstructed value.

### Parameters
- **plist** (&Value) - The input property list value to be parsed.

### Returns
- **Result<Value, PlistParseError>** - Returns the reconstructed `Value` on success, or a `PlistParseError` if parsing fails.
```

--------------------------------

### Retrieve User Home Directory in Rust

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.home.html

Returns the current user's home directory path as a String.

```rust
use imessage_database::util::dirs::home;

let path = home();
println!("{path}");
```

--------------------------------

### pub fn readable_diff(start: &DateTime<Local>, end: &DateTime<Local>) -> Option<String>

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.readable_diff.html

Formats the elapsed time between two local timestamps into a human-readable string representation.

```APIDOC
## readable_diff

### Description
Formats the elapsed time between two local timestamps into a human-readable string (e.g., "5 minutes, 2 seconds").

### Signature
`pub fn readable_diff(start: &DateTime<Local>, end: &DateTime<Local>) -> Option<String>`

### Parameters
- **start** (&DateTime<Local>) - The starting timestamp.
- **end** (&DateTime<Local>) - The ending timestamp.

### Returns
- **Option<String>** - A string representing the duration if the calculation is successful, otherwise None.

### Example
```rust
use chrono::prelude::*;
use imessage_database::util::dates::readable_diff;

let start = Local.with_ymd_and_hms(2020, 5, 20, 9, 10, 11).unwrap();
let end = Local.with_ymd_and_hms(2020, 5, 20, 9, 15, 13).unwrap();
println!("{}", readable_diff(&start, &end).unwrap()); // "5 minutes, 2 seconds"
```
```

--------------------------------

### set_start

Source: https://docs.rs/imessage-database/latest/imessage_database/util/query_context/struct.QueryContext.html?search=std%3A%3Avec

Sets the inclusive lower-bound timestamp for message dates using a YYYY-MM-DD string format.

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

### Description
Sets the inclusive lower-bound date for the query from a string in 'YYYY-MM-DD' format.

### Parameters
- **start** (str) - Required - The start date in YYYY-MM-DD format.

### Returns
- **Result<(), QueryContextError>** - Returns Ok(()) on success, or a QueryContextError if the date format is invalid.
```

--------------------------------

### Platform::from_cli

Source: https://docs.rs/imessage-database/latest/imessage_database/util/platform/enum.Platform.html

Parses a platform name string provided via CLI input into a Platform variant.

```APIDOC
## fn from_cli(platform: &str) -> Option<Self>

### Description
Parse a platform name from CLI input.

### Parameters
- **platform** (&str) - Required - The string representation of the platform (e.g., "macOS" or "iOS").
```

--------------------------------

### format_file_size(total_bytes: u64) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/size/fn.format_file_size.html

Formats a given number of bytes into a human-readable string representation using binary units (e.g., KB, MB).

```APIDOC
## Function: format_file_size

### Description
Formats a byte count with a binary unit suffix.

### Signature
`pub fn format_file_size(total_bytes: u64) -> String`

### Parameters
- **total_bytes** (u64) - The total number of bytes to be formatted.

### Returns
- **String** - A string representation of the file size with the appropriate binary unit suffix.

### Example
```rust
use imessage_database::util::size::format_file_size;

let size: String = format_file_size(5612000);
println!("{size}"); // 5.35 MB
```
```

--------------------------------

### Define ME constant

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/constant.ME.html

Represents the first-person display name for the database owner.

```rust
pub const ME: &str = "Me";
```

--------------------------------

### Retrieve default database path

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.default_db_path.html?search=

Returns a PathBuf representing the default location of the macOS Messages database.

```rust
pub fn default_db_path() -> PathBuf
```

--------------------------------

### get_db_size(path: &Path) -> Result<u64, TableError>

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/fn.get_db_size.html

Returns the database file size on disk given a path to the database file.

```APIDOC
## get_db_size

### Description
Returns the database file size on disk in bytes.

### Signature
`pub fn get_db_size(path: &Path) -> Result<u64, TableError>`

### Parameters
- **path** (&Path) - Required - The file system path to the iMessage database file.

### Returns
- **Result<u64, TableError>** - Returns the size of the file in bytes on success, or a TableError if the operation fails.

### Example
```rust
use imessage_database::{
    util::dirs::default_db_path,
    tables::table::get_db_size
};

let db_path = default_db_path();
let database_size_in_bytes = get_db_size(&db_path);
```
```

--------------------------------

### format_file_size(total_bytes: u64) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/size/fn.format_file_size.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Formats a given number of bytes into a string representation with appropriate binary unit suffixes (e.g., KB, MB).

```APIDOC
## Function: format_file_size

### Description
Formats a byte count into a human-readable string with a binary unit suffix.

### Signature
`pub fn format_file_size(total_bytes: u64) -> String`

### Parameters
- **total_bytes** (u64) - The total number of bytes to format.

### Example
```rust
use imessage_database::util::size::format_file_size;

let size: String = format_file_size(5612000);
println!("{size}"); // 5.35 MB
```
```

--------------------------------

### Convert Vec<u8> to String

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/polls/type.PollOptionID.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates converting a vector of bytes into a String using TryFrom, which validates UTF-8 data.

```rust
let s1 = b"hello world".to_vec();
let v1 = String::try_from(s1).unwrap();
assert_eq!(v1, "hello world");
```

--------------------------------

### Retrieve iMessage database size

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/fn.get_db_size.html

Calculates the size of the database file in bytes. Requires a valid path to the database file.

```rust
use imessage_database::{
    util::dirs::default_db_path,
    tables::table::get_db_size
};

let db_path = default_db_path();
let database_size_in_bytes = get_db_size(&db_path);
```

--------------------------------

### Convert iMessage timestamp to local time

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dates/fn.get_local_time.html

Demonstrates converting a raw timestamp using the current system offset.

```rust
use imessage_database::util::dates::{get_local_time, get_offset};

let current_offset = get_offset();
let local = get_local_time(674526582885055488, current_offset).unwrap();
```

--------------------------------

### format_file_size(total_bytes: u64) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/size/fn.format_file_size.html?search=

Formats a given byte count into a string representation with binary units (e.g., KB, MB).

```APIDOC
## Function: format_file_size

### Description
Formats a byte count (u64) into a human-readable string with a binary unit suffix.

### Signature
`pub fn format_file_size(total_bytes: u64) -> String`

### Parameters
- **total_bytes** (u64) - The total number of bytes to format.

### Returns
- **String** - A formatted string representing the size (e.g., "5.35 MB").

### Example
```rust
use imessage_database::util::size::format_file_size;

let size: String = format_file_size(5612000);
println!("{size}"); // 5.35 MB
```
```

--------------------------------

### format_file_size(total_bytes: u64) -> String

Source: https://docs.rs/imessage-database/latest/imessage_database/util/size/fn.format_file_size.html?search=std%3A%3Avec

Formats a given byte count into a string representation with appropriate binary unit suffixes (e.g., KB, MB).

```APIDOC
## Function: format_file_size

### Description
Formats a byte count (u64) into a human-readable string with a binary unit suffix.

### Signature
`pub fn format_file_size(total_bytes: u64) -> String`

### Parameters
- **total_bytes** (u64) - The total number of bytes to be formatted.

### Returns
- **String** - A string representation of the file size with a binary unit suffix.

### Example
```rust
use imessage_database::util::size::format_file_size;

let size: String = format_file_size(5612000);
println!("{size}"); // 5.35 MB
```
```

--------------------------------

### Open Messages database connection

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/fn.get_connection.html

Establishes a read-only connection to the iMessage database at the specified path.

```rust
use imessage_database::{
    util::dirs::default_db_path,
    tables::table::get_connection
};

let db_path = default_db_path();
let connection = get_connection(&db_path);
```

--------------------------------

### Function Signature for format_file_size

Source: https://docs.rs/imessage-database/latest/imessage_database/util/size/fn.format_file_size.html?search=

The function signature for formatting file sizes.

```rust
pub fn format_file_size(total_bytes: u64) -> String
```

--------------------------------

### QueryContext::set_start

Source: https://docs.rs/imessage-database/latest/imessage_database/util/query_context/struct.QueryContext.html?search=

Sets the inclusive lower-bound timestamp for message dates using a YYYY-MM-DD string format.

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

### Description
Sets the inclusive lower-bound date for the query from a string in YYYY-MM-DD format.

### Parameters
- **start** (str) - Required - The date string in YYYY-MM-DD format.
```

--------------------------------

### get_connection Function Signature

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/fn.get_connection.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The function signature for opening a read-only connection to the database.

```rust
pub fn get_connection(path: &Path) -> Result<Connection, TableError>
```

--------------------------------

### PartialEq Equality Implementation

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/business_chat/struct.ListPickerItem.html?search=u32+-%3E+bool

Implementation of equality testing for ListPickerItem instances.

```rust
fn eq(&self, other: &ListPickerItem) -> bool
```

--------------------------------

### Retrieve default database path

Source: https://docs.rs/imessage-database/latest/imessage_database/util/dirs/fn.default_db_path.html

Use this function to obtain the PathBuf pointing to the default location of the iMessage database on macOS.

```rust
use imessage_database::util::dirs::default_db_path;

let path = default_db_path();
println!("{path:?}");
```

--------------------------------

### Cache Handle display strings

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/handle/struct.Handle.html?search=

Caches handle display strings by row ID using the default database connection.

```rust
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);
```

--------------------------------

### Platform::determine

Source: https://docs.rs/imessage-database/latest/imessage_database/util/platform/enum.Platform.html

Detects whether a given file system path points to an iOS backup root or a macOS database.

```APIDOC
## fn determine(db_path: &Path) -> Result<Self, TableError>

### Description
Detects whether a path points to an iOS backup root or a macOS database.

### Parameters
- **db_path** (&Path) - Required - The file system path to evaluate.
```

--------------------------------

### Accessing STICKER_USER_INFO constant

Source: https://docs.rs/imessage-database/latest/imessage_database/tables/table/constant.STICKER_USER_INFO.html

Defines the table name string for sticker user information.

```rust
pub const STICKER_USER_INFO: &str = "sticker_user_info";
```

--------------------------------

### Into Trait Implementation

Source: https://docs.rs/imessage-database/latest/imessage_database/message_types/app/enum.CheckInKind.html?search=std%3A%3Avec

Provides the into conversion method.

```rust
impl<T, U> Into<U> for T
where U: From<T>,
```

```rust
fn into(self) -> U
```
Tokens:
Raw