CacheDebugOverlay<K, V> class

A debug-only overlay that displays live CacheMetrics on top of child.

Only renders in debug and profile builds. In release builds this widget is a transparent pass-through that returns child unchanged — zero overhead in production.

Usage

@override
Widget build(BuildContext context) {
  return CacheDebugOverlay(
    cache: myCache,
    child: MyApp(),
  );
}

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• CacheDebugOverlay

Constructors

CacheDebugOverlay({Key? key, required Cache<K, V> cache, required Widget child, Alignment alignment = Alignment.topRight})

const

Properties

alignment → Alignment

Where to position the metrics panel. Default: top-right.

final

cache → Cache<K, V>

The cache whose metrics are displayed.

final

child → Widget

The widget to display underneath the overlay.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<CacheDebugOverlay<K, V>>

Creates the mutable state for this widget at a given location in the tree.

override

debugDescribeChildren() → List<DiagnosticsNode>

Returns a list of DiagnosticsNode objects describing this node's children.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode

Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.

inherited

toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String

A string representation of this object.

inherited

toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String

Returns a string representation of this node and its descendants.

inherited

toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String

Returns a one-line detailed description of the object.

inherited

toStringShort() → String

A short, textual description of this widget.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited