framealloc 0.11.1

Intent-aware, thread-smart memory allocation for Rust game engines
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Diagnostics and UI integration hooks.
//!
//! This module provides:

#![allow(deprecated)]  // Internal uses of deprecated types are intentional
//! - **Runtime diagnostics**: Allocator-aware error messages with codes
//! - **UI integration**: Hooks for imgui, egui, or custom overlays
//! - **Profiler integration**: Tracy and custom profiler support
//! - **Strict mode**: Optional panic-on-error for CI
//! - **Behavior filtering**: Runtime detection of allocation pattern issues (v0.4.0)
//!
//! ## Diagnostic Codes
//!
//! | Code  | Meaning                        |
//! |-------|--------------------------------|
//! | FA0xx | Frame allocation issues        |
//! | FA1xx | Bevy integration issues        |
//! | FA2xx | Threading issues               |
//! | FA3xx | Budget/limit issues            |
//! | FA4xx | Handle/streaming issues        |
//! | FA5xx | Behavior pattern issues        |
//! | FA9xx | Internal errors                |
//!
//! ## Usage
//!
//! ```rust,ignore
//! use framealloc::{fa_diagnostic, fa_emit};
//!
//! // Emit a custom diagnostic
//! fa_diagnostic!(
//!     Error,
//!     code = "FA001",
//!     message = "frame allocation outside frame",
//!     help = "call begin_frame() first"
//! );
//!
//! // Emit a predefined diagnostic
//! fa_emit!(FA001);
//! ```

// Core diagnostic types
pub mod kind;
pub mod emit;
pub mod context;
pub mod strict;
pub mod macros;

// Behavior filtering (v0.4.0)
pub mod behavior;

// UI integration
mod hooks;
mod snapshot;
mod tracy;

// Re-export core types
pub use kind::{Diagnostic, DiagnosticKind, DiagnosticCode, DiagnosticLevel};
pub use emit::{emit, emit_with_context, suppress_diagnostics, set_verbose, DiagnosticSink, CollectingSink};
pub use context::{DiagContext, set_bevy_context, is_bevy_context, increment_frame, frame_number};
pub use strict::{StrictMode, set_strict_mode, strict_mode, StrictModeGuard, init_from_env};

// Re-export predefined diagnostics
pub use kind::{FA001, FA002, FA003, FA101, FA102, FA201, FA202, FA301, FA302, FA401, FA402, FA901};

// Behavior diagnostics (v0.4.0)
pub use behavior::{
    AllocKind, BehaviorFilter, BehaviorIssue, BehaviorReport, BehaviorThresholds,
    TagBehaviorStats, FA501, FA502, FA510, FA520, FA530,
};

// UI hooks
pub use hooks::{DiagnosticsHooks, DiagnosticsEvent, SharedDiagnostics, MemoryGraphData};
pub use snapshot::{AllocatorSnapshot, FrameSnapshot, PoolSnapshot, TagSnapshot, GlobalSnapshot, StreamingSnapshot, SnapshotHistory};
pub use tracy::{ProfilerHooks, ProfilerZone, MemoryEvent};