memscope-rs 0.2.0

A memory tracking library for Rust applications.
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GenericInstance {
    pub name: String,
    pub base_type: String,
    pub underlying_type: String,
    pub type_parameters: Vec<String>,
    pub ptr: usize,
    pub size: usize,
    pub constraints: Vec<GenericConstraint>,
    pub is_type_alias: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GenericConstraint {
    pub parameter_name: String,
    pub constraint_type: ConstraintType,
    pub description: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ConstraintType {
    Trait(String),
    Lifetime,
    Sized,
    Send,
    Sync,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InstantiationEvent {
    pub base_type: String,
    pub type_parameters: Vec<String>,
    pub ptr: usize,
    pub timestamp: u64,
    pub thread_id: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ConstraintViolation {
    pub constraint: GenericConstraint,
    pub actual_type: String,
    pub violation_type: ViolationType,
    pub timestamp: u64,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ViolationType {
    ConstraintNotSatisfied,
    LifetimeMismatch,
    MissingTraitImpl,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GenericStatistics {
    pub total_instances: usize,
    pub unique_base_types: usize,
    pub total_instantiations: usize,
    pub constraint_violations: usize,
    pub most_used_types: Vec<(String, usize)>,
    pub type_aliases_count: usize,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TypeAliasInfo {
    pub alias_name: String,
    pub underlying_type: String,
    pub base_type: String,
    pub type_parameters: Vec<String>,
    pub usage_count: usize,
}