Skip to content
🤔 Documentation issue? Report it

//leakcanary-repo/shark/LibraryLeak

LibraryLeak

[jvm]\ data class LibraryLeak(val leakTraces: List<LeakTrace>, val pattern: ReferencePattern, val description: String) : Leak

A leak found by HeapAnalyzer, where the only path to the leaking object required going through a reference matched by pattern, as provided to a LibraryLeakReferenceMatcher instance. This is a known leak in library code that is beyond your control.

Constructors

LibraryLeak [jvm]
constructor(leakTraces: List<LeakTrace>, pattern: ReferencePattern, description: String)

Types

Name Summary
Companion [jvm]
object Companion

Functions

Name Summary
toString [jvm]
open override fun toString(): String

Properties

Name Summary
description [jvm]
val description: String
A description that conveys what we know about this library leak.
leakTraces [jvm]
open override val leakTraces: List<LeakTrace>
Group of leak traces which share the same leak signature.
pattern [jvm]
val pattern: ReferencePattern
The pattern that matched one of the references in each of leakTraces, as provided to a LibraryLeakReferenceMatcher instance.
shortDescription [jvm]
open override val shortDescription: String
signature [jvm]
open override val signature: String
A unique SHA1 hash that represents this group of leak traces.
totalRetainedHeapByteSize [jvm]
val totalRetainedHeapByteSize: Int?
Sum of LeakTrace.retainedHeapByteSize for all elements in leakTraces. Null if the retained heap size was not computed.
totalRetainedObjectCount [jvm]
val totalRetainedObjectCount: Int?
Sum of LeakTrace.retainedObjectCount for all elements in leakTraces. Null if the retained heap size was not computed.