blob: 8697b30eb85ae74eebc3b42ec05aca3e4a58bff6 [file] [log] [blame] [view]
# ArchiveReader<METADATA> class
*[<Null safety>](https://dart.dev/null-safety)*
<p>Wrapper for the <a href="https://fuchsia.dev/reference/fidl/fuchsia.diagnostics#ArchiveAccessor">ArchiveAccessor</a>
service.</p>
<p>Basic use of this class is as follows:</p>
<pre class="language-dart"><code class="language-dart">final reader =
ArchiveReader.forInspect();
final snapshot = reader.snapshot;
</code></pre>
<p>TODO(fxbug.dev/71014): Implement lifecycle and log reading.</p>
## Properties
##### [diagnosticsConfiguration](../package-fuchsia_inspect_reader/ArchiveReader/diagnosticsConfiguration.md) &#8596; [DiagnosticsConfiguration](../package-fuchsia_inspect_reader/DiagnosticsConfiguration-class.md)&lt;METADATA>
_<span class="feature read / write">read / write</span>_
##### [hashCode](../package-fuchsia_inspect_reader/ArchiveReader/hashCode.md) &#8594; int
The hash code for this object.
_<span class="feature read-only">read-only</span><span class="feature inherited">inherited</span>_
##### [runtimeType](../package-fuchsia_inspect_reader/ArchiveReader/runtimeType.md) &#8594; Type
A representation of the runtime type of the object.
_<span class="feature read-only">read-only</span><span class="feature inherited">inherited</span>_
##### [selectors](../package-fuchsia_inspect_reader/ArchiveReader/selectors.md) &#8596; List&lt;[Selector](../package-fuchsia_inspect_reader/Selector-class.md)>?
_<span class="feature read / write">read / write</span>_
## Methods
##### [noSuchMethod](../package-fuchsia_inspect_reader/ArchiveReader/noSuchMethod.md)(Invocation invocation) dynamic
Invoked when a non-existent method or property is accessed.
_<span class="feature inherited">inherited</span>_
##### [snapshot](../package-fuchsia_inspect_reader/ArchiveReader/snapshot.md)({bool acceptSnapshot(List&lt;[DiagnosticsData](../package-fuchsia_inspect_reader/DiagnosticsData-class.md)&lt;METADATA>> snapshot)?, Duration attemptDelay = const Duration(milliseconds: 100), int? maxAttempts = 200}) Future&lt;List&lt;[DiagnosticsData](../package-fuchsia_inspect_reader/DiagnosticsData-class.md)&lt;METADATA>>>
Obtain a snapshot of the current inspect data as constrained by
<code>selector</code>.
##### [toString](../package-fuchsia_inspect_reader/ArchiveReader/toString.md)() String
A string representation of this object.
_<span class="feature inherited">inherited</span>_
## Operators
##### [operator ==](../package-fuchsia_inspect_reader/ArchiveReader/operator_equals.md)(Object other) bool
The equality operator.
_<span class="feature inherited">inherited</span>_
## Static Methods
##### [forInspect](../package-fuchsia_inspect_reader/ArchiveReader/forInspect.md)({List&lt;[Selector](../package-fuchsia_inspect_reader/Selector-class.md)>? selectors}) [ArchiveReader](../package-fuchsia_inspect_reader/ArchiveReader-class.md)&lt;[InspectMetadata](../package-fuchsia_inspect_reader/InspectMetadata-class.md)>
Create an <a href="../package-fuchsia_inspect_reader/ArchiveReader-class.md">ArchiveReader</a> for reading the data specified by
a <a href="../package-fuchsia_inspect_reader/InspectConfiguration-class.md">InspectConfiguration</a>, using the given <code>selectors</code>.