PrismCore / API reference / Probing and input

Class

ProbedSource

final class ProbedSource

Declared in Sources/PrismCore/Probe/ProbedSource.swift · PrismCore 3.5.4

No documentation comment in the source.

Instance properties

let info: SourceInfo

What the probe found. Safe to read after the context has been consumed: it is a value, copied out at probe time.

let structure: SourceStructure

The container's byte layout and seek index, for a caller that asked the open to measure them (SourceStructureExport).

SourceStructure.unknown otherwise, which is the default and costs nothing. It is a separate value from info because it answers a separate question — info is "what streams are in here", this is "where do they start and is there an index" — and because only one of the two is worth paying extra reads for.

let hints: HintOutcome

What became of the hints this open was given, if any. wereSupplied == false for every open that passed none, which is every open today.

let url: URL

The source this describes, so a consumer that needs to re-open (a fallback session, whose context was already taken) knows what to open.

let timing: ProbeTiming

Where the probe's time went — for the host's log line or telemetry. Exists because a 5.7 s probe on a device and a 135 ms probe on the bench were the same code, and without the phases there was nothing to argue about but intuition.

var prewarm: SourcePrewarmUse { get }

Whether this open started from prewarmed bytes (see PrismCoreEngine.prewarm). Always .none off the coordinated HTTP reader, which is the only transport that consults the prewarm store.

Generated from the public symbols of PrismCore 3.5.4. All types