Dotnet/I18NCommander
Dotnet/I18NCommander
1
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Added documentation

Browse Source
This commit is contained in:
Thorsten Sommer 2023-01-18 20:00:03 +01:00
parent b534dfdf85
commit f7186fd3cc
Signed by: tsommer
GPG Key ID: 371BBA77A02C0108
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
I18N Commander/DataModel/Database/Common/DataContext.cs
View File

@ -75,6 +75,9 @@ public sealed class DataContext : DbContext, IDataContext
IEnumerable<JsonTranslation> Translations IEnumerable<JsonTranslation> Translations
); );
/// <summary>
/// Represents a unique identifier for a JSON export and import.
/// </summary>
internal readonly record struct JsonUniqueId(string Code, Guid UniqueId, string Prefix = "") internal readonly record struct JsonUniqueId(string Code, Guid UniqueId, string Prefix = "")
{ {
public override string ToString() => string.IsNullOrWhiteSpace(this.Prefix) ? $"{this.Code}::{this.UniqueId}" : $"{this.Prefix}::{this.Code}::{this.UniqueId}"; public override string ToString() => string.IsNullOrWhiteSpace(this.Prefix) ? $"{this.Code}::{this.UniqueId}" : $"{this.Prefix}::{this.Code}::{this.UniqueId}";
@ -82,6 +85,9 @@ public sealed class DataContext : DbContext, IDataContext
public static implicit operator string(JsonUniqueId id) => id.ToString(); public static implicit operator string(JsonUniqueId id) => id.ToString();
} }
/// <summary>
/// A JSON converter to serialize and deserialize JsonUniqueId instances.
/// </summary>
private sealed class JsonUniqueIdConverter : JsonConverter<JsonUniqueId> private sealed class JsonUniqueIdConverter : JsonConverter<JsonUniqueId>
{ {
public override JsonUniqueId Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) public override JsonUniqueId Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
@ -138,6 +144,10 @@ public sealed class DataContext : DbContext, IDataContext
JsonUniqueId TextElementUniqueId JsonUniqueId TextElementUniqueId
); );
/// <summary>
/// Exports this database to a JSON file.
/// </summary>
/// <param name="path">The path to the JSON file.</param>
public async Task ExportAsync(string path) public async Task ExportAsync(string path)
{ {
var jsonSettings = new JsonSerializerOptions var jsonSettings = new JsonSerializerOptions