captrack 0.1.0

Capacity telemetry for Rust collections — call-site macros that record peak capacity, with zero overhead when disabled.
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

# clippy.toml.example — copy (fully or partially) into your project's clippy.toml
# to enforce the use of captrack macros at every collection call-site.
#
# Axis 3 — Policy belongs to the consumer, not to captrack itself.
# The captrack macros carry `#[allow(clippy::disallowed_methods)]` in their
# expansions, so they are always safe regardless of this policy.
#
# Strategy:
#   - Full adoption: copy the entire file.
#   - Partial: copy only the families you want to enforce.
#   - None: don't copy anything (telemetry still works via macros).

disallowed-methods = [
    # ── Vec ──────────────────────────────────────────────────────────────────
    { path = "std::vec::Vec::new",
      reason = "use captrack::tvec!(\"name\", cap)" },
    { path = "std::vec::Vec::with_capacity",
      reason = "use captrack::tvec!(\"name\", cap)" },

    # ── HashMap ───────────────────────────────────────────────────────────────
    { path = "std::collections::HashMap::new",
      reason = "use captrack::tfxmap!(\"name\", cap)" },
    { path = "std::collections::HashMap::with_capacity",
      reason = "use captrack::tfxmap!(\"name\", cap)" },
    { path = "std::collections::HashMap::with_hasher",
      reason = "use captrack::tfxmap!(\"name\", cap)" },
    { path = "std::collections::HashMap::with_capacity_and_hasher",
      reason = "use captrack::tfxmap!(\"name\", cap)" },

    # ── HashSet ───────────────────────────────────────────────────────────────
    { path = "std::collections::HashSet::new",
      reason = "use captrack::tfxset!(\"name\", cap)" },
    { path = "std::collections::HashSet::with_capacity",
      reason = "use captrack::tfxset!(\"name\", cap)" },
    { path = "std::collections::HashSet::with_hasher",
      reason = "use captrack::tfxset!(\"name\", cap)" },
    { path = "std::collections::HashSet::with_capacity_and_hasher",
      reason = "use captrack::tfxset!(\"name\", cap)" },

    # ── BTreeMap / BTreeSet ───────────────────────────────────────────────────
    { path = "std::collections::BTreeMap::new",
      reason = "use captrack::tbtreemap!(\"name\", cap_hint)" },
    { path = "std::collections::BTreeSet::new",
      reason = "use captrack::tbtreeset!(\"name\", cap_hint)" },

    # ── VecDeque ──────────────────────────────────────────────────────────────
    { path = "std::collections::VecDeque::new",
      reason = "use captrack::tvecdeque!(\"name\", cap)" },
    { path = "std::collections::VecDeque::with_capacity",
      reason = "use captrack::tvecdeque!(\"name\", cap)" },

    # ── bytes ─────────────────────────────────────────────────────────────────
    { path = "bytes::Bytes::new",
      reason = "use captrack::tbytesmut!(\"name\", cap)" },
    { path = "bytes::BytesMut::new",
      reason = "use captrack::tbytesmut!(\"name\", cap)" },
    { path = "bytes::BytesMut::with_capacity",
      reason = "use captrack::tbytesmut!(\"name\", cap)" },

    # ── indexmap ──────────────────────────────────────────────────────────────
    { path = "indexmap::IndexMap::new",
      reason = "use captrack::tmap!(\"name\", cap)" },
    { path = "indexmap::IndexMap::with_capacity",
      reason = "use captrack::tmap!(\"name\", cap)" },
    { path = "indexmap::IndexMap::with_hasher",
      reason = "use captrack::tmap!(\"name\", cap)" },
    { path = "indexmap::IndexMap::with_capacity_and_hasher",
      reason = "use captrack::tmap!(\"name\", cap)" },
    { path = "indexmap::IndexSet::new",
      reason = "use captrack::tset!(\"name\", cap)" },
    { path = "indexmap::IndexSet::with_capacity",
      reason = "use captrack::tset!(\"name\", cap)" },
    { path = "indexmap::IndexSet::with_hasher",
      reason = "use captrack::tset!(\"name\", cap)" },
    { path = "indexmap::IndexSet::with_capacity_and_hasher",
      reason = "use captrack::tset!(\"name\", cap)" },

    # ── dashmap ───────────────────────────────────────────────────────────────
    { path = "dashmap::DashMap::new",
      reason = "use captrack::tdashmap!(\"name\", cap)" },
    { path = "dashmap::DashMap::with_capacity",
      reason = "use captrack::tdashmap!(\"name\", cap)" },
    { path = "dashmap::DashMap::with_hasher",
      reason = "use captrack::tdashmap!(\"name\", cap)" },
    { path = "dashmap::DashMap::with_capacity_and_hasher",
      reason = "use captrack::tdashmap!(\"name\", cap)" },

    # ── scc ───────────────────────────────────────────────────────────────────
    { path = "scc::HashMap::new",
      reason = "use captrack::tsccmap!(\"name\", cap)" },
    { path = "scc::HashMap::with_capacity",
      reason = "use captrack::tsccmap!(\"name\", cap)" },
    { path = "scc::HashSet::new",
      reason = "use captrack::tsccset!(\"name\", cap)" },
    { path = "scc::HashSet::with_capacity",
      reason = "use captrack::tsccset!(\"name\", cap)" },
    { path = "scc::TreeIndex::new",
      reason = "use captrack::tscctree!(\"name\", cap_hint)" },

    # ── smallvec ──────────────────────────────────────────────────────────────
    { path = "smallvec::SmallVec::new",
      reason = "use captrack::tsmallvec!(\"name\", cap)" },
    { path = "smallvec::SmallVec::with_capacity",
      reason = "use captrack::tsmallvec!(\"name\", cap)" },

    # ── String / &str — NOT banned (user exception). ──────────────────────────
    # String is commonly used for format!/error messages where capacity
    # planning is rarely worthwhile.
]