Skip to content

Commit 3e118a6

Browse files
josesimoesjosesimoes
committed
Fixes from StyleCop analiser
1 parent dec21ba commit 3e118a6

File tree

10 files changed

+129
-126
lines changed

10 files changed

+129
-126
lines changed

‎Shared/MessagePack/Converters/IConverter.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@
77
namespace nanoFramework.MessagePack.Converters
88
{
99
/// <summary>
10-
/// Converter interface
10+
/// <see cref="Converter"/> interface.
1111
/// </summary>
1212
public interface IConverter
1313
{
1414
/// <summary>
15-
/// Write object in to target MessagePack stream
15+
/// Write object in to target MessagePack stream.
1616
/// </summary>
17-
/// <param name="value">Source object</param>
18-
/// <param name="writer">Target MessagePack stream</param>
17+
/// <param name="value">Source object.</param>
18+
/// <param name="writer">Target MessagePack stream.</param>
1919
#nullable enable
2020
void Write(object? value, [NotNull] IMessagePackWriter writer);
2121

2222
/// <summary>
23-
/// Read object from MessagePack stream
23+
/// Read object from MessagePack stream.
2424
/// </summary>
25-
/// <param name="reader">MessagePack stream</param>
26-
/// <returns>Readied object</returns>
25+
/// <param name="reader">MessagePack stream.</param>
26+
/// <returns>Readied object.</returns>
2727
object? Read([NotNull] IMessagePackReader reader);
2828
}
2929
}

‎Shared/MessagePack/Dto/ArraySegment.cs‎

Lines changed: 64 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace nanoFramework.MessagePack.Dto
88
{
99
/// <summary>
10-
/// Segment by bytes array
10+
/// Segment by byte array.
1111
/// </summary>
1212
public class ArraySegment : IEnumerable, IEnumerator
1313
{
@@ -16,11 +16,39 @@ public class ArraySegment : IEnumerable, IEnumerator
1616
private readonly long _length;
1717

1818
/// <summary>
19-
/// Segment constructor
19+
/// Gets the current position in the segment.
2020
/// </summary>
21-
/// <param name="buffer">Source byte array</param>
22-
/// <param name="offset">Offset in source byte array</param>
23-
/// <param name="length">Length segment</param>
21+
public long Position { get; private set; } = -1;
22+
23+
/// <summary>
24+
/// Gets the element corresponding to the current position in the segment.
25+
/// </summary>
26+
public object Current
27+
{
28+
get
29+
{
30+
if (Position >= _length)
31+
{
32+
throw ExceptionUtility.NotEnoughBytes(Position, _length);
33+
}
34+
35+
try
36+
{
37+
return _buffer[_offset + Position];
38+
}
39+
catch
40+
{
41+
throw ExceptionUtility.NotEnoughBytes(_offset + Position, _buffer.Length);
42+
}
43+
}
44+
}
45+
46+
/// <summary>
47+
/// Initializes a new instance of the <see cref="ArraySegment" /> class.
48+
/// </summary>
49+
/// <param name="buffer">Source byte array.</param>
50+
/// <param name="offset">Offset in source byte array.</param>
51+
/// <param name="length">Length segment.</param>
2452
public ArraySegment(byte[] buffer, long offset, long length)
2553
{
2654
_buffer = buffer;
@@ -29,9 +57,27 @@ public ArraySegment(byte[] buffer, long offset, long length)
2957
}
3058

3159
/// <summary>
32-
/// Rad one byte in segment
60+
/// Implicit conversion from byte array to <see cref="ArraySegment"/>.
3361
/// </summary>
34-
/// <returns>Reading byte</returns>
62+
/// <param name="bytes" Source byte array.</param>
63+
public static implicit operator ArraySegment(byte[] bytes)
64+
{
65+
return new ArraySegment(bytes, 0, bytes.Length);
66+
}
67+
68+
/// <summary>
69+
/// Implicit conversion from <see cref="ArraySegment"/> to byte array.
70+
/// </summary>
71+
/// <param name="segment">Source <see cref="ArraySegment"/>.</param>
72+
public static explicit operator byte[](ArraySegment segment)
73+
{
74+
return segment.ToArray();
75+
}
76+
77+
/// <summary>.
78+
/// Read one byte from the segment.
79+
/// </summary>
80+
/// <returns>The byte read.</returns>
3581
public byte ReadByte()
3682
{
3783
if (++Position >= _length)
@@ -48,18 +94,18 @@ public byte ReadByte()
4894
}
4995

5096
/// <summary>
51-
/// Get bytes enumerator
97+
/// Get bytes enumerator.
5298
/// </summary>
53-
/// <returns></returns>
99+
/// <returns>Enumerator for bytes in segment.</returns>
54100
public IEnumerator GetEnumerator()
55101
{
56102
return this;
57103
}
58104

59105
/// <summary>
60-
/// Go to next byte in array
106+
/// Go to next byte in array.
61107
/// </summary>
62-
/// <returns>True if the end of the segment is not reached otherwise false</returns>
108+
/// <returns><see langword="true"/> if the end of the segment is not reached otherwise <see langword="false"/>.</returns>
63109
public bool MoveNext()
64110
{
65111
Position++;
@@ -68,69 +114,24 @@ public bool MoveNext()
68114
}
69115

70116
/// <summary>
71-
/// Resets the current position to the beginning of the segment
117+
/// Resets the current position to the beginning of the segment.
72118
/// </summary>
73119
public void Reset()
74120
{
75121
Position = -1;
76122
}
77123

78-
/// <summary>
79-
/// Current position of the segment
80-
/// </summary>
81-
public long Position { get; private set; } = -1;
82-
83-
/// <summary>
84-
/// The element corresponding to the current position in the segment
85-
/// </summary>
86-
public object Current
87-
{
88-
get
89-
{
90-
if (Position >= _length)
91-
{
92-
throw ExceptionUtility.NotEnoughBytes(Position, _length);
93-
}
94-
95-
try
96-
{
97-
return _buffer[_offset + Position];
98-
}
99-
catch
100-
{
101-
throw ExceptionUtility.NotEnoughBytes(_offset + Position, _buffer.Length);
102-
}
103-
}
104-
}
105-
106124
private byte[] ToArray()
107125
{
108126
var data = new byte[_length];
109-
//for (int i = 0; i < data.Length; i++)
110-
//{
111-
// data[i] = _buffer[_offset + i];
112-
//}
113-
System.Array.Copy(_buffer, (int)_offset, data, 0, (int)_length);
114-
return data;
115-
}
116127

117-
/// <summary>
118-
/// Implicit conversion from byte array to <see cref="ArraySegment"/>.
119-
/// </summary>
120-
/// <param name="bytes"></param>
121-
public static implicit operator ArraySegment(byte[] bytes)
122-
{
123-
return new ArraySegment(bytes, 0, bytes.Length);
124-
}
128+
////for (int i = 0; i < data.Length; i++)
129+
////{
130+
//// data[i] = _buffer[_offset + i];
131+
////}
125132

126-
/// <summary>
127-
/// Implicit conversion from <see cref="ArraySegment"/> to byte array.
128-
/// </summary>
129-
/// <param name="segment"></param>
130-
public static explicit operator byte[](ArraySegment segment)
131-
{
132-
return segment.ToArray();
133+
System.Array.Copy(_buffer, (int)_offset, data, 0, (int)_length);
134+
return data;
133135
}
134-
135136
}
136137
}

‎Shared/MessagePack/Exceptions/ConverterNotFoundException.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,13 @@ namespace nanoFramework.MessagePack.Exceptions
1010
/// </summary>
1111
public class ConverterNotFoundException : Exception
1212
{
13-
1413
/// <summary>
1514
/// Gets the type of object which converter was not found.
1615
/// </summary>
1716
public Type ObjectType { get; }
1817

1918
/// <summary>
20-
/// Converter not found exception.
19+
/// Initializes a new instance of the <see cref="ConverterNotFoundException" /> class.
2120
/// </summary>
2221
/// <param name="type">Type of object.</param>
2322
public ConverterNotFoundException(Type type)

‎Shared/MessagePack/Exceptions/SerializationException.cs‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,11 @@ namespace nanoFramework.MessagePack.Exceptions
1111
public class SerializationException : Exception
1212
{
1313
/// <summary>
14-
/// Serialization exception.
14+
/// Initializes a new instance of the <see cref="SerializationException" /> class.
1515
/// </summary>
16-
/// <param name="message"></param>
16+
/// <param name="message">Error message.</param>
1717
public SerializationException(string message) : base(message)
1818
{
19-
2019
}
2120
}
2221
}

‎Shared/MessagePack/Extensions/DataTypesExtension.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ internal static byte GetHighBits(this DataTypes type, byte bitsCount)
1414

1515
internal static string JoinToString(this DataTypes[] types, string separator)
1616
{
17-
StringBuilder sb = new();
17+
StringBuilder sb = new ();
18+
1819
foreach (var item in types)
1920
{
2021
sb.Append(item);

‎Shared/MessagePack/Extensions/NumberConverterHelper.cs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,13 @@ internal static bool TryGetInt32(DataTypes type, IMessagePackReader reader, out
195195

196196
case DataTypes.UInt32:
197197
var uintValue = ReadUInt32(reader);
198+
198199
if (uintValue <= int.MaxValue)
199200
{
200201
result = (int)uintValue;
201202
return true;
202203
}
204+
203205
return false;
204206

205207
case DataTypes.Int8:
@@ -250,11 +252,13 @@ internal static bool TryGetInt64(DataTypes type, IMessagePackReader reader, out
250252

251253
case DataTypes.UInt64:
252254
var ulongValue = ReadUInt64(reader);
255+
253256
if (ulongValue <= long.MaxValue)
254257
{
255258
result = (long)ulongValue;
256259
return true;
257260
}
261+
258262
return false;
259263

260264
case DataTypes.Int8:

‎Shared/MessagePack/Stream/BaseReader.cs‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ public void SkipToken()
143143
SkipMapItems(mapLength);
144144
return;
145145
}
146+
146147
if (TryGetLengthFromFixStr(dataType, out var stringLength))
147148
{
148149
SkipBytes(stringLength);
@@ -159,6 +160,23 @@ public void SkipToken()
159160
var gatheredBytes = StopTokenGathering();
160161
return gatheredBytes;
161162
}
163+
private static bool TryGetLengthFromFixStr(DataTypes type, out uint length)
164+
{
165+
length = type - DataTypes.FixStr;
166+
return type.GetHighBits(3) == DataTypes.FixStr.GetHighBits(3);
167+
}
168+
169+
protected static bool TryGetLengthFromFixArray(DataTypes type, out uint length)
170+
{
171+
length = type - DataTypes.FixArray;
172+
return type.GetHighBits(4) == DataTypes.FixArray.GetHighBits(4);
173+
}
174+
175+
protected static bool TryGetLengthFromFixMap(DataTypes type, out uint length)
176+
{
177+
length = type - DataTypes.FixMap;
178+
return type.GetHighBits(4) == DataTypes.FixMap.GetHighBits(4);
179+
}
162180

163181
private void SkipMapItems(uint count)
164182
{
@@ -183,25 +201,7 @@ private void SkipBytes(uint bytesCount)
183201
{
184202
Seek(bytesCount, SeekOrigin.Current);
185203
}
186-
187-
private static bool TryGetLengthFromFixStr(DataTypes type, out uint length)
188-
{
189-
length = type - DataTypes.FixStr;
190-
return type.GetHighBits(3) == DataTypes.FixStr.GetHighBits(3);
191-
}
192-
193-
protected static bool TryGetLengthFromFixArray(DataTypes type, out uint length)
194-
{
195-
length = type - DataTypes.FixArray;
196-
return type.GetHighBits(4) == DataTypes.FixArray.GetHighBits(4);
197-
}
198-
199-
protected static bool TryGetLengthFromFixMap(DataTypes type, out uint length)
200-
{
201-
length = type - DataTypes.FixMap;
202-
return type.GetHighBits(4) == DataTypes.FixMap.GetHighBits(4);
203-
}
204-
204+
205205
protected abstract ArraySegment? StopTokenGathering();
206206

207207
protected abstract void StartTokenGathering();

0 commit comments

Comments
 (0)