Skip to content

Commit f6563a2

Browse files
committed
Added methods description
1 parent b3c5002 commit f6563a2

File tree

3 files changed

+42
-15
lines changed

3 files changed

+42
-15
lines changed

Shared/MessagePack/Converters/IConverter.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace nanoFramework.MessagePack.Converters
88
{
99
/// <summary>
10-
/// <see cref="Converter"/> interface.
10+
/// <see cref="IConverter"/> interface.
1111
/// </summary>
1212
public interface IConverter
1313
{

Shared/MessagePack/Dto/ArraySegment.cs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ public override byte ReadByte()
106106
/// <summary>
107107
/// Implicit conversion from byte array to <see cref="ArraySegment"/>.
108108
/// </summary>
109-
/// <param name="bytes" Source byte array.</param>
109+
/// <param name="bytes"> Source byte array.</param>
110110
public static implicit operator ArraySegment(byte[] bytes)
111111
{
112112
return new ArraySegment(bytes, 0, bytes.Length);
@@ -138,6 +138,10 @@ private byte[] ToArray()
138138
return data;
139139
}
140140

141+
/// <summary>
142+
/// Stopping the collection of MessagePack token in <see cref="ArraySegment"/>
143+
/// </summary>
144+
/// <returns>Array segment bytes <see cref="ArraySegment"/></returns>
141145
#nullable enable
142146
protected override ArraySegment? StopTokenGathering()
143147
{
@@ -153,6 +157,10 @@ private byte[] ToArray()
153157
return null;
154158
}
155159
}
160+
161+
/// <summary>
162+
/// Start the collection of MessagePack token in <see cref="ArraySegment"/>
163+
/// </summary>
156164
protected override void StartTokenGathering()
157165
{
158166
_firstGatheredByte = Position;

Shared/MessagePack/Stream/BaseReader.cs

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -205,18 +205,6 @@ private static bool TryGetLengthFromFixStr(DataTypes type, out uint length)
205205
return type.GetHighBits(3) == DataTypes.FixStr.GetHighBits(3);
206206
}
207207

208-
protected static bool TryGetLengthFromFixArray(DataTypes type, out uint length)
209-
{
210-
length = type - DataTypes.FixArray;
211-
return type.GetHighBits(4) == DataTypes.FixArray.GetHighBits(4);
212-
}
213-
214-
protected static bool TryGetLengthFromFixMap(DataTypes type, out uint length)
215-
{
216-
length = type - DataTypes.FixMap;
217-
return type.GetHighBits(4) == DataTypes.FixMap.GetHighBits(4);
218-
}
219-
220208
private void SkipMapItems(uint count)
221209
{
222210
while (count > 0)
@@ -240,9 +228,40 @@ private void SkipBytes(uint bytesCount)
240228
{
241229
Seek(bytesCount, SeekOrigin.Current);
242230
}
243-
231+
232+
/// <summary>
233+
/// Try getting length fixed MessagePack Array
234+
/// </summary>
235+
/// <param name="type">MessagePack Array type <see cref="DataTypes.FixArray"/></param>
236+
/// <param name="length">Out length MessagePack Array</param>
237+
/// <returns>True if luck otherwise false</returns>
238+
protected static bool TryGetLengthFromFixArray(DataTypes type, out uint length)
239+
{
240+
length = type - DataTypes.FixArray;
241+
return type.GetHighBits(4) == DataTypes.FixArray.GetHighBits(4);
242+
}
243+
244+
/// <summary>
245+
/// Try getting length fixed MessagePack Map
246+
/// </summary>
247+
/// <param name="type">MessagePack Map type <see cref="DataTypes.FixMap"/></param>
248+
/// <param name="length">Out length MessagePack Map</param>
249+
/// <returns>True if luck otherwise false</returns>
250+
protected static bool TryGetLengthFromFixMap(DataTypes type, out uint length)
251+
{
252+
length = type - DataTypes.FixMap;
253+
return type.GetHighBits(4) == DataTypes.FixMap.GetHighBits(4);
254+
}
255+
256+
/// <summary>
257+
/// Stopping the collection of MessagePack token
258+
/// </summary>
259+
/// <returns>Array segment bytes <see cref="ArraySegment"/></returns>
244260
protected abstract ArraySegment? StopTokenGathering();
245261

262+
/// <summary>
263+
/// Start the collection of MessagePack token
264+
/// </summary>
246265
protected abstract void StartTokenGathering();
247266
}
248267
}

0 commit comments

Comments
 (0)