CodecFileInventory
- Namespace
- Rowles.LeanCorpus.Index.Format
- Assembly
- Rowles.LeanCorpus.dll
Describes one index file and the codec version detected from its header.
public sealed record CodecFileInventory : IEquatable<CodecFileInventory>- Inheritance
-
CodecFileInventory
- Implements
ChecksumAlgorithm
Gets the canonical checksum algorithm, when the frame records one.
ChecksumStatus
Gets whether an available checksum was verified successfully.
CodecName
Gets the logical codec name.
CompoundFileName
Gets the owning compound file name for a compound member.
CurrentFormatVersion
Gets the current body-format version from the catalogue.
CurrentVersion
Gets the current codec version supported by this build, or null when the file has no standard codec header.
ErrorCode
Gets the structured frame error category, when inspection failed.
Extension
Gets the file extension.
FamilyId
Gets the stable catalogue family identifier, when recognised.
FamilyName
Gets the human-readable catalogue family name, when recognised.
FieldName
Gets the related field name, when known.
FileName
Gets the file name relative to the index directory.
FormatId
Gets the stable catalogue format identifier, when recognised.
FormatVersion
Gets the detected body-format version, or null for versionless formats.
FrameKind
Gets the detected frame kind.
FrameVersion
Gets the detected frame version, or null for legacy and external framing.
HasValidMagic
Gets a value indicating whether the file has the expected LeanCorpus codec magic.
IsCompoundMember
Gets whether this inventory entry describes a compound member.
IsCurrent
Gets a value indicating whether the file is already at the current codec version.
IsKnownFormat
Gets whether the logical file resolved to a registered catalogue format.
IsSupported
Gets a value indicating whether this build can read the detected version.
Length
Gets the file length in bytes when requested.
MagicStatus
Gets the explicit magic applicability and validity state.
PhysicalFileName
Gets the physical file name, which is the compound container for a compound member.
PhysicalLocation
Gets where the logical file is physically stored.
SegmentId
Gets the related segment ID, when known.
Version
Gets the detected on-disk codec version, or null when the file has no standard codec header.