ResidentFootprint class

Available extensions

Constructors

ResidentFootprint({String? workspace, String? branch, Int64? readModelBytes, Int64? readModelRustBytes, Int64? foldStateBytes, int? foldImages, Int64? sharedAttributedBytes, Int64? aggregates, Iterable<ResidentComponent>? components, Int64? computeUs, ReadProjectionStorageKind? readStorageKind, Int64? sqliteCacheUsedBytes, Int64? flatScalarRows, Int64? flatScalarRowsRead, String? fullReplayHead})
factory
ResidentFootprint.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
ResidentFootprint.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

aggregates ↔ Int64
getter/setter pair
branch ↔ String
getter/setter pair
components → PbList<ResidentComponent>
The same total, broken into what it is MADE OF, so a console can nest one more level: a workspace is not a leaf, it is a box containing its fold images, its read model, its share of law, its git object cache. Sums to the fields above; a consumer may render either.
no setter
computeUs ↔ Int64
Compute attributed to this workspace since the last drain, so a view can colour by heat while sizing by memory. Zero means not measured (accounting compiled out), never "did no work".
getter/setter pair
flatScalarRows ↔ Int64
getter/setter pair
flatScalarRowsRead ↔ Int64
getter/setter pair
foldImages ↔ int
getter/setter pair
foldStateBytes ↔ Int64
getter/setter pair
fullReplayHead ↔ String
Process-local proof of a complete genesis-to-head replay. This is the kernel's own latest walked verdict for this branch; never inferred from retained Git custody. A later head or a new process has no matching proof until it walks in that process.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
readModelBytes ↔ Int64
EXACT (page_count × page_size), always populated: the read model's SQLite image.
getter/setter pair
readModelRustBytes ↔ Int64
Deep-only, and all LOWER BOUNDS. Rust-side read-model indexes; the fold images this workspace holds (up to four full Workspace snapshots live per branch: the fold frontier, the canonical pre-author parent, the deferred-projection parent, and the pinned checkpoint); and this workspace's FRACTIONAL share of interned payloads, divided by holder count so one multi-MB law shared across frontiers is not charged in full to every one of them.
getter/setter pair
readStorageKind ↔ ReadProjectionStorageKind
Physical read storage is observable, never selected by the telemetry caller.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sharedAttributedBytes ↔ Int64
getter/setter pair
sqliteCacheUsedBytes ↔ Int64
SQLite page-cache allocation, not the on-disk image length.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
workspace ↔ String
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAggregates() → void
clearBranch() → void
clearComputeUs() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearFlatScalarRows() → void
clearFlatScalarRowsRead() → void
clearFoldImages() → void
clearFoldStateBytes() → void
clearFullReplayHead() → void
clearReadModelBytes() → void
clearReadModelRustBytes() → void
clearReadStorageKind() → void
clearSharedAttributedBytes() → void
clearSqliteCacheUsedBytes() → void
clearWorkspace() → void
clone() → ResidentFootprint
Creates a deep copy of the fields in this message.
copyWith(void updates(ResidentFootprint)) → ResidentFootprint
Apply updates to a copy of this message.
createEmptyInstance() → ResidentFootprint
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasAggregates() → bool
hasBranch() → bool
hasComputeUs() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasFlatScalarRows() → bool
hasFlatScalarRowsRead() → bool
hasFoldImages() → bool
hasFoldStateBytes() → bool
hasFullReplayHead() → bool
hasReadModelBytes() → bool
hasReadModelRustBytes() → bool
hasReadStorageKind() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSharedAttributedBytes() → bool
hasSqliteCacheUsedBytes() → bool
hasWorkspace() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited