From 592a3d35053a418decad779178582c8ac7671bae Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Fri, 26 Sep 2025 15:10:59 -0400 Subject: [PATCH] Rename *Serializer interfaces to *Writer --- README.MD | 24 +++++++++---------- .../Interfaces/IByteSerializer.cs | 4 ++-- .../Interfaces/IFileSerializer.cs | 4 ++-- .../Interfaces/IStreamSerializer.cs | 4 ++-- .../Interfaces/IStringSerializer.cs | 4 ++-- .../Serializers/AttractMode.cs | 8 +++---- .../Serializers/BaseBinarySerializer.cs | 18 +++++++------- .../Serializers/ClrMamePro.cs | 8 +++---- .../Serializers/CueSheet.cs | 2 +- .../Serializers/DosCenter.cs | 2 +- .../Serializers/EverdriveSMDB.cs | 2 +- .../Serializers/Hashfile.cs | 8 +++---- SabreTools.Serialization/Serializers/IRD.cs | 2 +- .../Serializers/JsonFile.cs | 8 +++---- .../Serializers/Listrom.cs | 2 +- .../Serializers/Logiqx.cs | 6 ++--- .../Serializers/OpenMSX.cs | 6 ++--- .../Serializers/RomCenter.cs | 2 +- .../Serializers/SeparatedValue.cs | 8 +++---- .../Serializers/SoftwareList.cs | 4 ++-- SabreTools.Serialization/Serializers/XMID.cs | 4 ++-- SabreTools.Serialization/Serializers/XeMID.cs | 4 ++-- .../Serializers/XmlFile.cs | 8 +++---- 23 files changed, 71 insertions(+), 71 deletions(-) diff --git a/README.MD b/README.MD index a3bcfd68..865e470a 100644 --- a/README.MD +++ b/README.MD @@ -84,23 +84,23 @@ Below is a table representing the various conversion interfaces that are impleme | Interface Name | Source Type | Destination Type | | --- | --- | --- | -| `IByteReader` | `byte[]?` | Model | -| `IByteSerializer` | Model | `byte[]?` | -| `IFileReader` | `string?` path | Model | -| `IFileSerializer` | Model | `string?` path | -| `IModelSerializer` | Model | Model | -| `IStreamReader` | `Stream?` | Model | -| `IStreamSerializer` | Model | `Stream?` | -| `IStringReader` | `string?` representation | Model | -| `IStringSerializer` | Model | `string?` representation | +| `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 | Below is a table representing the various non-conversion interfaces that are implemented within this library. | Interface Name | Purpose | | --- | --- | -| `IExtractable` | Marks a wrapper as able to be extracted | -| `IPrinter` | Provides a formatted output for a model | -| `IWrapper` / `IWrapper` | Wraps a model or set of models to provide additional functionality | +| `SabreTools.Serialization.Interfaces.IExtractable` | Marks a wrapper as able to be extracted | +| `SabreTools.Serialization.Interfaces.IPrinter` | Provides a formatted output for a model | +| `SabreTools.Serialization.Interfaces.IWrapper` / `SabreTools.Serialization.Interfaces.IWrapper` | Wraps a model or set of models to provide additional functionality | ## Namespaces diff --git a/SabreTools.Serialization/Interfaces/IByteSerializer.cs b/SabreTools.Serialization/Interfaces/IByteSerializer.cs index 7752e41e..a786a0ff 100644 --- a/SabreTools.Serialization/Interfaces/IByteSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IByteSerializer.cs @@ -1,9 +1,9 @@ namespace SabreTools.Serialization.Interfaces { /// - /// Defines how to serialize to byte arrays + /// Defines how to write to byte arrays /// - public interface IByteSerializer + public interface IByteWriter { /// /// Serialize a into a byte array diff --git a/SabreTools.Serialization/Interfaces/IFileSerializer.cs b/SabreTools.Serialization/Interfaces/IFileSerializer.cs index daec50ff..40a20c8e 100644 --- a/SabreTools.Serialization/Interfaces/IFileSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IFileSerializer.cs @@ -1,9 +1,9 @@ namespace SabreTools.Serialization.Interfaces { /// - /// Defines how to serialize to files + /// Defines how to write to files /// - public interface IFileSerializer + public interface IFileWriter { /// /// Serialize a into a file diff --git a/SabreTools.Serialization/Interfaces/IStreamSerializer.cs b/SabreTools.Serialization/Interfaces/IStreamSerializer.cs index 1bb2a485..30cb3d57 100644 --- a/SabreTools.Serialization/Interfaces/IStreamSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IStreamSerializer.cs @@ -1,9 +1,9 @@ namespace SabreTools.Serialization.Interfaces { /// - /// Defines how to serialize to Streams + /// Defines how to write to Streams /// - public interface IStreamSerializer + public interface IStreamWriter { /// /// Serialize a into a Stream diff --git a/SabreTools.Serialization/Interfaces/IStringSerializer.cs b/SabreTools.Serialization/Interfaces/IStringSerializer.cs index b0a1194f..15cea669 100644 --- a/SabreTools.Serialization/Interfaces/IStringSerializer.cs +++ b/SabreTools.Serialization/Interfaces/IStringSerializer.cs @@ -1,9 +1,9 @@ namespace SabreTools.Serialization.Interfaces { /// - /// Defines how to serialize from strings + /// Defines how to write to strings /// - public interface IStringSerializer + public interface IStringWriter { /// /// Serialize a into a string diff --git a/SabreTools.Serialization/Serializers/AttractMode.cs b/SabreTools.Serialization/Serializers/AttractMode.cs index 7ed4183f..201ab78a 100644 --- a/SabreTools.Serialization/Serializers/AttractMode.cs +++ b/SabreTools.Serialization/Serializers/AttractMode.cs @@ -5,7 +5,7 @@ using SabreTools.IO.Writers; namespace SabreTools.Serialization.Writers { - public class AttractMode : BaseBinarySerializer + public class AttractMode : BaseBinaryWriter { #region Constants @@ -62,7 +62,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(MetadataFile? obj) @@ -82,7 +82,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(MetadataFile? obj, string? path) @@ -107,7 +107,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(MetadataFile? obj) diff --git a/SabreTools.Serialization/Serializers/BaseBinarySerializer.cs b/SabreTools.Serialization/Serializers/BaseBinarySerializer.cs index e05c4ca7..7f41e789 100644 --- a/SabreTools.Serialization/Serializers/BaseBinarySerializer.cs +++ b/SabreTools.Serialization/Serializers/BaseBinarySerializer.cs @@ -8,15 +8,15 @@ namespace SabreTools.Serialization.Writers /// /// Type of the model to serialize /// - /// This class allows all inheriting types to only implement - /// and still implicitly implement and + /// This class allows all inheriting types to only implement + /// and still implicitly implement and /// - public abstract class BaseBinarySerializer : - IByteSerializer, - IFileSerializer, - IStreamSerializer + public abstract class BaseBinaryWriter : + IByteWriter, + IFileWriter, + IStreamWriter { - #region IByteSerializer + #region IByteWriter /// public virtual byte[]? SerializeArray(TModel? obj) @@ -32,7 +32,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public virtual bool SerializeFile(TModel? obj, string? path) @@ -53,7 +53,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public abstract Stream? SerializeStream(TModel? obj); diff --git a/SabreTools.Serialization/Serializers/ClrMamePro.cs b/SabreTools.Serialization/Serializers/ClrMamePro.cs index 584f35ca..7b2de2de 100644 --- a/SabreTools.Serialization/Serializers/ClrMamePro.cs +++ b/SabreTools.Serialization/Serializers/ClrMamePro.cs @@ -5,9 +5,9 @@ using SabreTools.IO.Writers; namespace SabreTools.Serialization.Writers { - public class ClrMamePro : BaseBinarySerializer + public class ClrMamePro : BaseBinaryWriter { - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(MetadataFile? obj) @@ -27,7 +27,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(MetadataFile? obj, string? path) @@ -52,7 +52,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(MetadataFile? obj) diff --git a/SabreTools.Serialization/Serializers/CueSheet.cs b/SabreTools.Serialization/Serializers/CueSheet.cs index 93d5c5b7..d9851875 100644 --- a/SabreTools.Serialization/Serializers/CueSheet.cs +++ b/SabreTools.Serialization/Serializers/CueSheet.cs @@ -5,7 +5,7 @@ using SabreTools.Data.Models.CueSheets; namespace SabreTools.Serialization.Writers { - public class CueSheet : BaseBinarySerializer + public class CueSheet : BaseBinaryWriter { /// public override Stream? SerializeStream(Data.Models.CueSheets.CueSheet? obj) diff --git a/SabreTools.Serialization/Serializers/DosCenter.cs b/SabreTools.Serialization/Serializers/DosCenter.cs index faef0ed9..ab238ed8 100644 --- a/SabreTools.Serialization/Serializers/DosCenter.cs +++ b/SabreTools.Serialization/Serializers/DosCenter.cs @@ -5,7 +5,7 @@ using SabreTools.IO.Writers; namespace SabreTools.Serialization.Writers { - public class DosCenter : BaseBinarySerializer + public class DosCenter : BaseBinaryWriter { /// public override Stream? SerializeStream(MetadataFile? obj) diff --git a/SabreTools.Serialization/Serializers/EverdriveSMDB.cs b/SabreTools.Serialization/Serializers/EverdriveSMDB.cs index 5adca238..49e562ec 100644 --- a/SabreTools.Serialization/Serializers/EverdriveSMDB.cs +++ b/SabreTools.Serialization/Serializers/EverdriveSMDB.cs @@ -6,7 +6,7 @@ using SabreTools.IO.Writers; namespace SabreTools.Serialization.Writers { - public class EverdriveSMDB : BaseBinarySerializer + public class EverdriveSMDB : BaseBinaryWriter { /// public override Stream? SerializeStream(MetadataFile? obj) diff --git a/SabreTools.Serialization/Serializers/Hashfile.cs b/SabreTools.Serialization/Serializers/Hashfile.cs index 83eaad95..d6f188f8 100644 --- a/SabreTools.Serialization/Serializers/Hashfile.cs +++ b/SabreTools.Serialization/Serializers/Hashfile.cs @@ -7,9 +7,9 @@ using SabreTools.IO.Writers; namespace SabreTools.Serialization.Writers { - public class Hashfile : BaseBinarySerializer + public class Hashfile : BaseBinaryWriter { - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(Data.Models.Hashfile.Hashfile? obj) @@ -29,7 +29,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(Data.Models.Hashfile.Hashfile? obj, string? path) @@ -54,7 +54,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(Data.Models.Hashfile.Hashfile? obj) diff --git a/SabreTools.Serialization/Serializers/IRD.cs b/SabreTools.Serialization/Serializers/IRD.cs index 0a91f601..1916baaa 100644 --- a/SabreTools.Serialization/Serializers/IRD.cs +++ b/SabreTools.Serialization/Serializers/IRD.cs @@ -4,7 +4,7 @@ using System.Text; namespace SabreTools.Serialization.Writers { - public class IRD : BaseBinarySerializer + public class IRD : BaseBinaryWriter { /// public override Stream? SerializeStream(Data.Models.IRD.File? obj) diff --git a/SabreTools.Serialization/Serializers/JsonFile.cs b/SabreTools.Serialization/Serializers/JsonFile.cs index 4bd19228..522b9c82 100644 --- a/SabreTools.Serialization/Serializers/JsonFile.cs +++ b/SabreTools.Serialization/Serializers/JsonFile.cs @@ -8,9 +8,9 @@ namespace SabreTools.Serialization.Writers /// Base class for other JSON serializers /// /// - public class JsonFile : BaseBinarySerializer + public class JsonFile : BaseBinaryWriter { - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(T? obj) @@ -36,7 +36,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(T? obj, string? path) @@ -68,7 +68,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(T? obj) diff --git a/SabreTools.Serialization/Serializers/Listrom.cs b/SabreTools.Serialization/Serializers/Listrom.cs index 6a95e279..102d6918 100644 --- a/SabreTools.Serialization/Serializers/Listrom.cs +++ b/SabreTools.Serialization/Serializers/Listrom.cs @@ -4,7 +4,7 @@ using SabreTools.Data.Models.Listrom; namespace SabreTools.Serialization.Writers { - public class Listrom : BaseBinarySerializer + public class Listrom : BaseBinaryWriter { /// public override Stream? SerializeStream(MetadataFile? obj) diff --git a/SabreTools.Serialization/Serializers/Logiqx.cs b/SabreTools.Serialization/Serializers/Logiqx.cs index 67637b86..0fc7a258 100644 --- a/SabreTools.Serialization/Serializers/Logiqx.cs +++ b/SabreTools.Serialization/Serializers/Logiqx.cs @@ -29,7 +29,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(Datafile? obj) @@ -37,7 +37,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(Datafile? obj, string? path) @@ -45,7 +45,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(Datafile? obj) diff --git a/SabreTools.Serialization/Serializers/OpenMSX.cs b/SabreTools.Serialization/Serializers/OpenMSX.cs index 29bfe597..fadd2aea 100644 --- a/SabreTools.Serialization/Serializers/OpenMSX.cs +++ b/SabreTools.Serialization/Serializers/OpenMSX.cs @@ -29,7 +29,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(SoftwareDb? obj) @@ -37,7 +37,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(SoftwareDb? obj, string? path) @@ -45,7 +45,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(SoftwareDb? obj) diff --git a/SabreTools.Serialization/Serializers/RomCenter.cs b/SabreTools.Serialization/Serializers/RomCenter.cs index b7a5753a..5e9fdd4d 100644 --- a/SabreTools.Serialization/Serializers/RomCenter.cs +++ b/SabreTools.Serialization/Serializers/RomCenter.cs @@ -5,7 +5,7 @@ using SabreTools.IO.Writers; namespace SabreTools.Serialization.Writers { - public class RomCenter : BaseBinarySerializer + public class RomCenter : BaseBinaryWriter { /// public override Stream? SerializeStream(MetadataFile? obj) diff --git a/SabreTools.Serialization/Serializers/SeparatedValue.cs b/SabreTools.Serialization/Serializers/SeparatedValue.cs index 45b2e68b..f94f14c0 100644 --- a/SabreTools.Serialization/Serializers/SeparatedValue.cs +++ b/SabreTools.Serialization/Serializers/SeparatedValue.cs @@ -5,7 +5,7 @@ using SabreTools.IO.Writers; namespace SabreTools.Serialization.Writers { - public class SeparatedValue : BaseBinarySerializer + public class SeparatedValue : BaseBinaryWriter { #region Constants @@ -50,7 +50,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(MetadataFile? obj) @@ -70,7 +70,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(MetadataFile? obj, string? path) @@ -95,7 +95,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(MetadataFile? obj) diff --git a/SabreTools.Serialization/Serializers/SoftwareList.cs b/SabreTools.Serialization/Serializers/SoftwareList.cs index 57e1caa2..8006bf2c 100644 --- a/SabreTools.Serialization/Serializers/SoftwareList.cs +++ b/SabreTools.Serialization/Serializers/SoftwareList.cs @@ -28,7 +28,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(Data.Models.SoftwareList.SoftwareList? obj, string? path) @@ -36,7 +36,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(Data.Models.SoftwareList.SoftwareList? obj) diff --git a/SabreTools.Serialization/Serializers/XMID.cs b/SabreTools.Serialization/Serializers/XMID.cs index c6d0b5a8..ccbfe125 100644 --- a/SabreTools.Serialization/Serializers/XMID.cs +++ b/SabreTools.Serialization/Serializers/XMID.cs @@ -3,9 +3,9 @@ using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Writers { - public partial class XMID : IStringSerializer + public partial class XMID : IStringWriter { - /// + /// public static string? SerializeString(Data.Models.Xbox.XMID? obj) { var deserializer = new XMID(); diff --git a/SabreTools.Serialization/Serializers/XeMID.cs b/SabreTools.Serialization/Serializers/XeMID.cs index 19f48de0..868214ec 100644 --- a/SabreTools.Serialization/Serializers/XeMID.cs +++ b/SabreTools.Serialization/Serializers/XeMID.cs @@ -3,9 +3,9 @@ using SabreTools.Serialization.Interfaces; namespace SabreTools.Serialization.Writers { - public partial class XeMID : IStringSerializer + public partial class XeMID : IStringWriter { - /// + /// public static string? SerializeString(Data.Models.Xbox.XeMID? obj) { var deserializer = new XeMID(); diff --git a/SabreTools.Serialization/Serializers/XmlFile.cs b/SabreTools.Serialization/Serializers/XmlFile.cs index 838612fb..f3e7f507 100644 --- a/SabreTools.Serialization/Serializers/XmlFile.cs +++ b/SabreTools.Serialization/Serializers/XmlFile.cs @@ -9,9 +9,9 @@ namespace SabreTools.Serialization.Writers /// Base class for other XML serializers /// /// - public class XmlFile : BaseBinarySerializer + public class XmlFile : BaseBinaryWriter { - #region IByteSerializer + #region IByteWriter /// public override byte[]? SerializeArray(T? obj) @@ -39,7 +39,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IFileSerializer + #region IFileWriter /// public override bool SerializeFile(T? obj, string? path) @@ -73,7 +73,7 @@ namespace SabreTools.Serialization.Writers #endregion - #region IStreamSerializer + #region IStreamWriter /// public override Stream? SerializeStream(T? obj)