Logo FSBarV1_Archived

SmfParseError Type

Errors surfaced by the SMF parser. Callers pattern-match for diagnostics.

Union cases

Union case Description

ArchiveNotFound path

Full Usage: ArchiveNotFound path

Parameters:
    path : string

The .sd7 file is missing from the filesystem.

path : string

ExtractionFailed(archive, stderr)

Full Usage: ExtractionFailed(archive, stderr)

Parameters:
    archive : string
    stderr : string

bsdtar (or equivalent extractor) failed. stderr is attached.

archive : string
stderr : string

InvalidMagic actualHex

Full Usage: InvalidMagic actualHex

Parameters:
    actualHex : string

The .smf bytes did not start with the SMF magic header.

actualHex : string

NoSmfInArchive archive

Full Usage: NoSmfInArchive archive

Parameters:
    archive : string

The .sd7 extracted successfully but contained no .smf entry.

archive : string

Truncated(atOffset, expectedBytes, availableBytes)

Full Usage: Truncated(atOffset, expectedBytes, availableBytes)

Parameters:
    atOffset : int
    expectedBytes : int
    availableBytes : int

A size-field in the header pointed outside the byte buffer.

atOffset : int
expectedBytes : int
availableBytes : int

UnsupportedVersion version

Full Usage: UnsupportedVersion version

Parameters:
    version : int

The .smf format version is newer than the parser supports.

version : int

Instance members

Instance member Description

this.IsArchiveNotFound

Full Usage: this.IsArchiveNotFound

Returns: bool
Returns: bool

this.IsExtractionFailed

Full Usage: this.IsExtractionFailed

Returns: bool
Returns: bool

this.IsInvalidMagic

Full Usage: this.IsInvalidMagic

Returns: bool
Returns: bool

this.IsNoSmfInArchive

Full Usage: this.IsNoSmfInArchive

Returns: bool
Returns: bool

this.IsTruncated

Full Usage: this.IsTruncated

Returns: bool
Returns: bool

this.IsUnsupportedVersion

Full Usage: this.IsUnsupportedVersion

Returns: bool
Returns: bool

Type something to start searching.