From 6853376f60bd1b815c6d4b84f33019d3cfcb7f9c Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Fri, 26 Sep 2025 15:28:53 -0400 Subject: [PATCH] Unify type parameter naming --- README.MD | 23 ++++++++++--------- .../Interfaces/IByteReader.cs | 6 ++--- .../Interfaces/IByteSerializer.cs | 6 ++--- .../Interfaces/IFileDeserializer.cs | 6 ++--- .../Interfaces/IFileSerializer.cs | 6 ++--- .../Interfaces/IModelSerializer.cs | 10 ++++---- .../Interfaces/IStreamDeserializer.cs | 6 ++--- .../Interfaces/IStreamSerializer.cs | 6 ++--- .../Interfaces/IStringDeserializer.cs | 6 ++--- .../Interfaces/IStringSerializer.cs | 6 ++--- 10 files changed, 41 insertions(+), 40 deletions(-) diff --git a/README.MD b/README.MD index 30fafa8f..269f9143 100644 --- a/README.MD +++ b/README.MD @@ -84,23 +84,24 @@ Below is a table representing the various conversion interfaces that are impleme | Interface Name | Source Type | Destination Type | | --- | --- | --- | -| `SabreTools.Serialization.Interfaces.IByteReader` | `byte[]?` | Model | -| `SabreTools.Serialization.Interfaces.IByteWriter` | Model | `byte[]?` | -| `SabreTools.Serialization.Interfaces.IFileReader` | `string?` path | Model | -| `SabreTools.Serialization.Interfaces.IFileWriter` | Model | `string?` path | -| `SabreTools.Serialization.Interfaces.IModelSerializer` | Model | Model | -| `SabreTools.Serialization.Interfaces.IStreamReader` | `Stream?` | Model | -| `SabreTools.Serialization.Interfaces.IStreamWriter` | Model | `Stream?` | -| `SabreTools.Serialization.Interfaces.IStringReader` | `string?` representation | Model | -| `SabreTools.Serialization.Interfaces.IStringWriter` | Model | `string?` representation | +| `SabreTools.Serialization.Interfaces.IByteReader` | `byte[]?` | `TModel` | +| `SabreTools.Serialization.Interfaces.IByteWriter` | `TModel` | `byte[]?` | +| `SabreTools.Serialization.Interfaces.IFileReader` | `string?` path | `TModel` | +| `SabreTools.Serialization.Interfaces.IFileWriter` | `TModel` | `string?` path | +| `SabreTools.Serialization.Interfaces.IModelSerializer` | `TSource`/`TDest` | `TDest`/`TSource` | +| `SabreTools.Serialization.Interfaces.IStreamReader` | `Stream?` | `TModel` | +| `SabreTools.Serialization.Interfaces.IStreamWriter` | `TModel` | `Stream?` | +| `SabreTools.Serialization.Interfaces.IStringReader` | `string?` representation | `TModel` | +| `SabreTools.Serialization.Interfaces.IStringWriter` | `TModel` | `string?` representation | Below is a table representing the various non-conversion interfaces that are implemented within this library. | Interface Name | Purpose | | --- | --- | -| `SabreTools.Data.Printers.IPrinter` | Provides a formatted output for a model | +| `SabreTools.Data.Printers.IPrinter` | Provides a formatted output for a `TModel` | | `SabreTools.Serialization.Wrappers.IExtractable` | Marks a wrapper as able to be extracted | -| `SabreTools.Serialization.Wrappers.IWrapper` / `SabreTools.Serialization.Wrappers.IWrapper` | Wraps a model or set of models to provide additional functionality | +| `SabreTools.Serialization.Wrappers.IWrapper` | Represents an item with a description and JSON serializable state, allowing for extensions | +| `SabreTools.Serialization.Wrappers.IWrapper` | Wraps a model with source data, allowing for extensions | ## Namespaces diff --git a/SabreTools.Serialization/Interfaces/IByteReader.cs b/SabreTools.Serialization/Interfaces/IByteReader.cs index 5823f2bc..6f196c39 100644 --- a/SabreTools.Serialization/Interfaces/IByteReader.cs +++ b/SabreTools.Serialization/Interfaces/IByteReader.cs @@ -3,15 +3,15 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to read from byte arrays /// - public interface IByteReader + public interface IByteReader { /// - /// Deserialize a byte array into + /// Deserialize a byte array into /// /// Type of object to deserialize to /// Byte array to parse /// Offset into the byte array /// Filled object on success, null on error - T? Deserialize(byte[]? data, int offset); + TModel? Deserialize(byte[]? data, int offset); } } diff --git a/SabreTools.Serialization/Interfaces/IByteSerializer.cs b/SabreTools.Serialization/Interfaces/IByteSerializer.cs index a786a0ff..f71f9978 100644 --- a/SabreTools.Serialization/Interfaces/IByteSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IByteSerializer.cs @@ -3,14 +3,14 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to write to byte arrays /// - public interface IByteWriter + public interface IByteWriter { /// - /// Serialize a into a byte array + /// Serialize a into a byte array /// /// Type of object to serialize from /// Data to serialize /// Filled object on success, null on error - byte[]? SerializeArray(T? obj); + byte[]? SerializeArray(TModel? obj); } } diff --git a/SabreTools.Serialization/Interfaces/IFileDeserializer.cs b/SabreTools.Serialization/Interfaces/IFileDeserializer.cs index 706a3aa3..386ea820 100644 --- a/SabreTools.Serialization/Interfaces/IFileDeserializer.cs +++ b/SabreTools.Serialization/Interfaces/IFileDeserializer.cs @@ -3,14 +3,14 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to read from files /// - public interface IFileReader + public interface IFileReader { /// - /// Deserialize a file into + /// Deserialize a file into /// /// Type of object to deserialize to /// Path to deserialize from /// Filled object on success, null on error - T? Deserialize(string? path); + TModel? Deserialize(string? path); } } diff --git a/SabreTools.Serialization/Interfaces/IFileSerializer.cs b/SabreTools.Serialization/Interfaces/IFileSerializer.cs index 40a20c8e..90c198cf 100644 --- a/SabreTools.Serialization/Interfaces/IFileSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IFileSerializer.cs @@ -3,15 +3,15 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to write to files /// - public interface IFileWriter + public interface IFileWriter { /// - /// Serialize a into a file + /// Serialize a into a file /// /// Type of object to serialize from /// Data to serialize /// Path to the file to serialize to /// True on successful serialization, false otherwise - bool SerializeFile(T? obj, string? path); + bool SerializeFile(TModel? obj, string? path); } } diff --git a/SabreTools.Serialization/Interfaces/IModelSerializer.cs b/SabreTools.Serialization/Interfaces/IModelSerializer.cs index 3b249a15..c321d3c5 100644 --- a/SabreTools.Serialization/Interfaces/IModelSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IModelSerializer.cs @@ -3,24 +3,24 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to serialize to and from models /// - public interface IModelSerializer + public interface IModelSerializer { /// - /// Deserialize a into + /// Deserialize a into /// /// Type of object to deserialize to /// Type of object to deserialize from /// Object to deserialize from /// Filled object on success, null on error - T? Deserialize(U? obj); + TSource? Deserialize(TDest? obj); /// - /// Serialize a into + /// Serialize a into /// /// Type of object to serialize from /// Type of object to serialize to /// Object to serialize from /// Filled object on success, null on error - U? Serialize(T? obj); + TDest? Serialize(TSource? obj); } } diff --git a/SabreTools.Serialization/Interfaces/IStreamDeserializer.cs b/SabreTools.Serialization/Interfaces/IStreamDeserializer.cs index 65f18b82..e3875a33 100644 --- a/SabreTools.Serialization/Interfaces/IStreamDeserializer.cs +++ b/SabreTools.Serialization/Interfaces/IStreamDeserializer.cs @@ -3,14 +3,14 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to read from Streams /// - public interface IStreamReader + public interface IStreamReader { /// - /// Deserialize a Stream into + /// Deserialize a Stream into /// /// Type of object to deserialize to /// Stream to parse /// Filled object on success, null on error - T? Deserialize(System.IO.Stream? data); + TModel? Deserialize(System.IO.Stream? data); } } diff --git a/SabreTools.Serialization/Interfaces/IStreamSerializer.cs b/SabreTools.Serialization/Interfaces/IStreamSerializer.cs index 30cb3d57..7a3c420e 100644 --- a/SabreTools.Serialization/Interfaces/IStreamSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IStreamSerializer.cs @@ -3,14 +3,14 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to write to Streams /// - public interface IStreamWriter + public interface IStreamWriter { /// - /// Serialize a into a Stream + /// Serialize a into a Stream /// /// Type of object to serialize from /// Data to serialize /// Filled object on success, null on error - System.IO.Stream? SerializeStream(T? obj); + System.IO.Stream? SerializeStream(TModel? obj); } } diff --git a/SabreTools.Serialization/Interfaces/IStringDeserializer.cs b/SabreTools.Serialization/Interfaces/IStringDeserializer.cs index d029dade..ba12fc7a 100644 --- a/SabreTools.Serialization/Interfaces/IStringDeserializer.cs +++ b/SabreTools.Serialization/Interfaces/IStringDeserializer.cs @@ -3,14 +3,14 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to read from strings /// - public interface IStringReader + public interface IStringReader { /// - /// Deserialize a string into + /// Deserialize a string into /// /// Type of object to deserialize to /// String to deserialize from /// Filled object on success, null on error - T? Deserialize(string? str); + TModel? Deserialize(string? str); } } diff --git a/SabreTools.Serialization/Interfaces/IStringSerializer.cs b/SabreTools.Serialization/Interfaces/IStringSerializer.cs index 15cea669..0699bc33 100644 --- a/SabreTools.Serialization/Interfaces/IStringSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IStringSerializer.cs @@ -3,14 +3,14 @@ namespace SabreTools.Serialization.Interfaces /// /// Defines how to write to strings /// - public interface IStringWriter + public interface IStringWriter { /// - /// Serialize a into a string + /// Serialize a into a string /// /// Type of object to serialize from /// Data to serialize /// Filled string on successful serialization, null otherwise - string? Serialize(T? obj); + string? Serialize(TModel? obj); } }