SabreTools/SabreTools.Serialization
1
0
Fork 0
mirror of https://github.com/SabreTools/SabreTools.Serialization.git synced 2026-09-22 23:05:12 +00:00
Code Issues 56 Packages Projects Releases 20 Wiki Activity

Add better summaries for things

Browse Source
This commit is contained in:
Matt Nadareski
2025-09-16 22:07:05 -04:00
parent 10848e6c51
commit ca7c88cef6
2 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
SabreTools.Serialization/Wrappers/WrapperBase.cs
View File

@@ -70,6 +70,7 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a byte array
/// </summary>
/// <param name="data">Underlying data for the wrapper</param>
protected WrapperBase(byte[] data)
: this(data, 0, data.Length)
{
@@ -78,6 +79,8 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a byte array
/// </summary>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
protected WrapperBase(byte[] data, int offset)
: this(data, offset, data.Length - offset)
{
@@ -86,6 +89,10 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a byte array
/// </summary>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
/// <param name="length">Length of the window into the data</param>
/// <exception cref="ArgumentOutOfRangeException"></exception>
protected WrapperBase(byte[] data, int offset, int length)
{
if (offset < 0 || offset >= data.Length)
@@ -103,6 +110,7 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a Stream
/// </summary>
/// <param name="data">Underlying data for the wrapper</param>
/// <remarks>Uses the current stream position as the offset</remarks>
protected WrapperBase(Stream data)
: this(data, data.Position, data.Length - data.Position)
@@ -112,6 +120,8 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a Stream
/// </summary>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
protected WrapperBase(Stream data, long offset)
: this(data, offset, data.Length - offset)
{
@@ -120,6 +130,10 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a Stream
/// </summary>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
/// <param name="length">Length of the window into the data</param>
/// <exception cref="ArgumentOutOfRangeException"></exception>
protected WrapperBase(Stream data, long offset, long length)
{
if (!data.CanSeek || !data.CanRead)

18
SabreTools.Serialization/Wrappers/WrapperBaseT.cs
View File

@@ -22,6 +22,8 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a byte array
/// </summary>
/// <param name="model">Model to be used in the wrapper</param>
/// <param name="data">Underlying data for the wrapper</param>
protected WrapperBase(T model, byte[] data)
: this(model, data, 0, data.Length)
{
@@ -30,6 +32,9 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a byte array
/// </summary>
/// <param name="model">Model to be used in the wrapper</param>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
protected WrapperBase(T model, byte[] data, int offset)
: this(model, data, offset, data.Length - offset)
{
@@ -38,6 +43,10 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a byte array
/// </summary>
/// <param name="model">Model to be used in the wrapper</param>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
/// <param name="length">Length of the window into the data</param>
protected WrapperBase(T model, byte[] data, int offset, int length)
: base(data, offset, length)
{
@@ -51,6 +60,8 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a Stream
/// </summary>
/// <param name="model">Model to be used in the wrapper</param>
/// <param name="data">Underlying data for the wrapper</param>
/// <remarks>Uses the current stream position as the offset</remarks>
protected WrapperBase(T model, Stream data)
: this(model, data, data.Position, data.Length - data.Position)
@@ -60,6 +71,9 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a Stream
/// </summary>
/// <param name="model">Model to be used in the wrapper</param>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
protected WrapperBase(T model, Stream data, long offset)
: this(model, data, offset, data.Length - offset)
{
@@ -68,6 +82,10 @@ namespace SabreTools.Serialization.Wrappers
/// <summary>
/// Construct a new instance of the wrapper from a Stream
/// </summary>
/// <param name="model">Model to be used in the wrapper</param>
/// <param name="data">Underlying data for the wrapper</param>
/// <param name="offset">Offset into the data to use as the window start</param>
/// <param name="length">Length of the window into the data</param>
protected WrapperBase(T model, Stream data, long offset, long length)
: base(data, offset, length)
{