Struct MemoryReport

Source

#[non_exhaustive]
pub struct MemoryReport {Show 42 fields
    pub group_cache: CollectionStats,
    pub device_registry_cache: CollectionStats,
    pub lid_pn_lid_entries: CollectionStats,
    pub lid_pn_pn_entries: CollectionStats,
    pub recent_messages: CollectionStats,
    pub sender_key_device_cache: CollectionStats,
    pub group_devices_memo: CollectionStats,
    pub dm_devices_memo: CollectionStats,
    pub message_retry_counts: u64,
    pub undecryptable_dispatched: u64,
    pub pdo_pending_requests: u64,
    pub pdo_requested: u64,
    pub history_sync_tasks: CollectionStats,
    pub history_sync_tasks_peak: u64,
    pub history_sync_payload_bytes_peak: u64,
    pub session_locks: u64,
    pub chat_lanes: u64,
    pub group_distribution_locks: u64,
    pub group_distribution_lock_evictions: u64,
    pub group_distribution_lock_eviction_blocks: u64,
    pub resend_rate_limiter_chats: u64,
    pub transport_ack_queue: usize,
    pub delivery_receipt_queue: usize,
    pub response_waiters: usize,
    pub node_waiters: usize,
    pub pending_retries: usize,
    pub presence_subscriptions: usize,
    pub app_state_key_requests: usize,
    pub app_state_syncing: usize,
    pub signal_sessions: CollectionStats,
    pub signal_identities: CollectionStats,
    pub signal_sender_keys: CollectionStats,
    pub plugins: u64,
    pub plugin_install_tasks: u64,
    pub plugin_connection_tasks: u64,
    pub plugin_connection_generations: u64,
    pub plugin_core_event_subscriptions: u64,
    pub plugin_event_endpoints: u64,
    pub plugin_event_endpoint_capacity: u64,
    pub plugin_event_queue: CollectionStats,
    pub chatstate_handlers: usize,
    pub custom_enc_handlers: usize,
}

Expand description

On-demand report of the client’s internal collections: entry counts plus estimated retained heap bytes for the memory-dominant caches.

Counts are approximate (caches may have pending evictions); byte figures are honest estimates (encoded-size proxies for Signal records, payload sums elsewhere — see wacore::stats::HeapSize), suitable for per-session attribution and leak detection, not byte-exact accounting. Store-backed caches report bytes: 0 — their entries live outside this process.

Call Client::memory_report to obtain one. Nothing is computed unless called.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§group_cache: CollectionStats§device_registry_cache: CollectionStats§lid_pn_lid_entries: CollectionStats§lid_pn_pn_entries: CollectionStats

Entry count of the PN-direction map. Both maps share the same Arc<LidPnEntry> payloads, attributed to Self::lid_pn_lid_entries; bytes here cover only entries the LID map no longer holds (normally 0), so the total counts each once.

§recent_messages: CollectionStats§sender_key_device_cache: CollectionStats§group_devices_memo: CollectionStats§dm_devices_memo: CollectionStats§message_retry_counts: u64§undecryptable_dispatched: u64§pdo_pending_requests: u64§pdo_requested: u64§history_sync_tasks: CollectionStats

Queued/running history-sync tasks and their logical compressed-payload byte sum. A shared Bytes slice may retain a larger backing allocation, whose capacity is not exposed by the type.

§history_sync_tasks_peak: u64

Lifetime high-water mark of queued/running history-sync tasks.

§history_sync_payload_bytes_peak: u64

Lifetime high-water mark of logical compressed-payload bytes.

§session_locks: u64§chat_lanes: u64§group_distribution_locks: u64§group_distribution_lock_evictions: u64

Cumulative capacity evictions; poll successive reports to derive a rate.

§group_distribution_lock_eviction_blocks: u64

Cumulative attempts that kept a live lane and temporarily exceeded capacity.

§resend_rate_limiter_chats: u64§transport_ack_queue: usize

Deferred acks queued for the transport-ack worker. Unbounded, and each entry retains the full inbound node plus a flush guard, so a stalled transport shows up here as a growing backlog.

§delivery_receipt_queue: usize

Delivery receipts queued for their worker, same shape as above.

§response_waiters: usize§node_waiters: usize§pending_retries: usize§presence_subscriptions: usize§app_state_key_requests: usize§app_state_syncing: usize§signal_sessions: CollectionStats§signal_identities: CollectionStats§signal_sender_keys: CollectionStats§plugins: u64