AnkiIO 1.0.2
Build, validate, import, and export Anki-compatible decks from .NET
Loading...
Searching...
No Matches
AnkiIO.CrowdAnkiImportResult(AnkiDeck Deck, IReadOnlyList< AnkiDiagnostic > Diagnostics) Class Referencesealed

Returns a CrowdAnki-style import together with explicit information about concepts that could not be recovered. More...

Properties

AnkiDeck Deck = Deck [get]
 Gets the mutable imported hierarchy.
IReadOnlyList< AnkiDiagnostic > Diagnostics = Diagnostics [get]
 Gets ordered compatibility and loss diagnostics for this import.

Detailed Description

Returns a CrowdAnki-style import together with explicit information about concepts that could not be recovered.

Parameters
DeckThe newly reconstructed, mutable root deck.
DiagnosticsOrdered compatibility and data-loss findings produced during import.

Import success does not imply a lossless conversion. In particular, CROWD001 reports that card IDs, scheduling, flags, and review history were regenerated or omitted, while CROWD002 reports media filenames whose sibling file payloads were unavailable to the string-only importer. Inspect Diagnostics before exporting Deck to another format.

The record retains both constructor arguments by reference. The deck remains mutable and is not safe for concurrent mutation; the diagnostics list should be treated as read-only.

CrowdAnkiImportResult imported = CrowdAnkiJson.Import(json);
foreach (AnkiDiagnostic diagnostic in imported.Diagnostics)
{
Console.WriteLine($"{diagnostic.Code}: {diagnostic.Message}");
}
AnkiIO.AnkiDiagnostic
Provides one machine-readable validation, compatibility, or preservation finding.
Definition AnkiDiagnostic.cs:42
AnkiIO.CrowdAnkiImportResult
Returns a CrowdAnki-style import together with explicit information about concepts that could not be ...
Definition CrowdAnkiImportResult.cs:26
AnkiIO.CrowdAnkiImportResult.Diagnostics
IReadOnlyList< AnkiDiagnostic > Diagnostics
Gets ordered compatibility and loss diagnostics for this import.
Definition CrowdAnkiImportResult.cs:33
AnkiIO.CrowdAnkiJson
Imports and exports a conservative, independently implemented subset of CrowdAnki-style JSON.
Definition CrowdAnkiJson.cs:18
AnkiIO.CrowdAnkiJson.Import
static CrowdAnkiImportResult Import(string json)
Imports the supported CrowdAnki-style JSON subset and reports lossy concepts as structured diagnostic...
Definition CrowdAnkiJson.cs:77

Definition at line 25 of file CrowdAnkiImportResult.cs.

Property Documentation

◆ Deck

AnkiDeck AnkiIO.CrowdAnkiImportResult.Deck = Deck
get

Gets the mutable imported hierarchy.

The same deck instance supplied to the constructor; no defensive clone is made.

Definition at line 29 of file CrowdAnkiImportResult.cs.

◆ Diagnostics

IReadOnlyList<AnkiDiagnostic> AnkiIO.CrowdAnkiImportResult.Diagnostics = Diagnostics
get

Gets ordered compatibility and loss diagnostics for this import.

The same read-only-list reference supplied to the constructor.

Definition at line 33 of file CrowdAnkiImportResult.cs.

The documentation for this class was generated from the following file: