Section navigation

Public classSealed CodecFileDescriptor

Namespace
Rowles.LeanCorpus.Codecs.CodecKit
Assembly
Rowles.LeanCorpus.dll

Describes one physical or logical persistent file role owned by a codec family.

public sealed class CodecFileDescriptor
Inheritance
CodecFileDescriptor

Public constructor CodecFileDescriptor(string, string, string, CodecFileMatcher, int?, IEnumerable<CodecVersionDescriptor>?, CodecAccessKind, CodecFramingPolicy, CodecChecksumPolicy, CodecMigrationBehaviour, IEnumerable<CodecFileMatcher>?, ICodecFileValidationHandler?, ICodecFileMigrationHandler?)

Creates a persistent file descriptor.

Public property AccessKind

Gets how the body is consumed.

Public property ChecksumPolicy

Gets the checksum required for current writes.

Public property CurrentFormatVersion

Gets the current writable body-format version, or null for a versionless format.

Public property CurrentFraming

Gets the framing used by current writes.

Public property DisplayName

Gets the human-readable file-role name.

Public property FamilyId

Gets the identifier of the owning family.

Public property FileMatcher

Gets the matcher used to recognise logical file names.

Public property FormatId

Gets the stable, namespaced format identifier.

Public property MigrationBehaviour

Gets how legacy storage for this role reaches current storage.

Public property MigrationHandler

Gets the optional specialist migration handler.

Public property SupportedVersions

Gets supported versions in strictly increasing order.

Public property TemporaryFileMatchers

Gets matchers for temporary files owned by this role.

Public property ValidationHandler

Gets the optional specialist semantic validation handler.

Edit this page