forked from mongodb/mongo-csharp-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
BsonBinaryData.cs
400 lines (371 loc) · 14.7 KB
/
BsonBinaryData.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
/* Copyright 2010-2012 10gen Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace MongoDB.Bson
{
/// <summary>
/// Represents BSON binary data.
/// </summary>
[Serializable]
public class BsonBinaryData : BsonValue, IComparable<BsonBinaryData>, IEquatable<BsonBinaryData>
{
// private fields
private byte[] _bytes;
private BsonBinarySubType _subType;
private GuidRepresentation _guidRepresentation; // only relevant if subType is UuidStandard or UuidLegacy
// constructors
/// <summary>
/// Initializes a new instance of the BsonBinaryData class.
/// </summary>
/// <param name="bytes">The binary data.</param>
public BsonBinaryData(byte[] bytes)
: this(bytes, BsonBinarySubType.Binary)
{
}
/// <summary>
/// Initializes a new instance of the BsonBinaryData class.
/// </summary>
/// <param name="bytes">The binary data.</param>
/// <param name="subType">The binary data subtype.</param>
public BsonBinaryData(byte[] bytes, BsonBinarySubType subType)
: this(bytes, subType, GuidRepresentation.Unspecified)
{
}
/// <summary>
/// Initializes a new instance of the BsonBinaryData class.
/// </summary>
/// <param name="bytes">The binary data.</param>
/// <param name="subType">The binary data subtype.</param>
/// <param name="guidRepresentation">The representation for Guids.</param>
public BsonBinaryData(byte[] bytes, BsonBinarySubType subType, GuidRepresentation guidRepresentation)
: base(BsonType.Binary)
{
if (subType == BsonBinarySubType.UuidStandard || subType == BsonBinarySubType.UuidLegacy)
{
if (bytes.Length != 16)
{
var message = string.Format(
"Length must be 16, not {0}, when subType is {1}.",
bytes.Length, subType);
throw new ArgumentException(message);
}
var expectedSubType = (guidRepresentation == GuidRepresentation.Standard) ? BsonBinarySubType.UuidStandard : BsonBinarySubType.UuidLegacy;
if (subType != expectedSubType)
{
var message = string.Format(
"SubType must be {0}, not {1}, when GuidRepresentation is {2}.",
expectedSubType, subType, GuidRepresentation);
throw new ArgumentException(message);
}
}
else
{
if (guidRepresentation != GuidRepresentation.Unspecified)
{
var message = string.Format(
"GuidRepresentation must be Unspecified, not {0}, when SubType is not UuidStandard or UuidLegacy.",
guidRepresentation);
throw new ArgumentException(message);
}
}
_bytes = bytes;
_subType = subType;
_guidRepresentation = guidRepresentation;
}
/// <summary>
/// Initializes a new instance of the BsonBinaryData class.
/// </summary>
/// <param name="guid">A Guid.</param>
public BsonBinaryData(Guid guid)
: this(guid, BsonDefaults.GuidRepresentation)
{
}
/// <summary>
/// Initializes a new instance of the BsonBinaryData class.
/// </summary>
/// <param name="guid">A Guid.</param>
/// <param name="guidRepresentation">The representation for Guids.</param>
public BsonBinaryData(Guid guid, GuidRepresentation guidRepresentation)
: this(GuidConverter.ToBytes(guid, guidRepresentation), (guidRepresentation == GuidRepresentation.Standard) ? BsonBinarySubType.UuidStandard : BsonBinarySubType.UuidLegacy, guidRepresentation)
{
}
// public properties
/// <summary>
/// Gets the binary data.
/// </summary>
public byte[] Bytes
{
get { return _bytes; }
}
/// <summary>
/// Gets the representation to use when representing the Guid as BSON binary data.
/// </summary>
public GuidRepresentation GuidRepresentation
{
get { return _guidRepresentation; }
}
/// <summary>
/// Gets the BsonBinaryData as a Guid if the subtype is UuidStandard or UuidLegacy, otherwise null.
/// </summary>
public override object RawValue
{
get
{
if (_subType == BsonBinarySubType.UuidStandard || _subType == BsonBinarySubType.UuidLegacy)
{
return ToGuid();
}
else
{
return null;
}
}
}
/// <summary>
/// Gets the binary data subtype.
/// </summary>
public BsonBinarySubType SubType
{
get { return _subType; }
}
// public operators
/// <summary>
/// Converts a byte array to a BsonBinaryData.
/// </summary>
/// <param name="value">A byte array.</param>
/// <returns>A BsonBinaryData.</returns>
public static implicit operator BsonBinaryData(byte[] value)
{
return BsonBinaryData.Create(value);
}
/// <summary>
/// Converts a Guid to a BsonBinaryData.
/// </summary>
/// <param name="value">A Guid.</param>
/// <returns>A BsonBinaryData.</returns>
public static implicit operator BsonBinaryData(Guid value)
{
return new BsonBinaryData(value);
}
/// <summary>
/// Compares two BsonBinaryData values.
/// </summary>
/// <param name="lhs">The first BsonBinaryData.</param>
/// <param name="rhs">The other BsonBinaryData.</param>
/// <returns>True if the two BsonBinaryData values are not equal according to ==.</returns>
public static bool operator !=(BsonBinaryData lhs, BsonBinaryData rhs)
{
return !(lhs == rhs);
}
/// <summary>
/// Compares two BsonBinaryData values.
/// </summary>
/// <param name="lhs">The first BsonBinaryData.</param>
/// <param name="rhs">The other BsonBinaryData.</param>
/// <returns>True if the two BsonBinaryData values are equal according to ==.</returns>
public static bool operator ==(BsonBinaryData lhs, BsonBinaryData rhs)
{
if (object.ReferenceEquals(lhs, null)) { return object.ReferenceEquals(rhs, null); }
return lhs.Equals(rhs);
}
// public static methods
/// <summary>
/// Creates a new BsonBinaryData.
/// </summary>
/// <param name="bytes">The binary data.</param>
/// <returns>A BsonBinaryData or null.</returns>
public static BsonBinaryData Create(byte[] bytes)
{
return Create(bytes, BsonBinarySubType.Binary);
}
/// <summary>
/// Creates a new BsonBinaryData.
/// </summary>
/// <param name="bytes">The binary data.</param>
/// <param name="subType">The binary data subtype.</param>
/// <returns>A BsonBinaryData or null.</returns>
public static BsonBinaryData Create(byte[] bytes, BsonBinarySubType subType)
{
if (bytes != null)
{
return new BsonBinaryData(bytes, subType);
}
else
{
return null;
}
}
/// <summary>
/// Creates a new BsonBinaryData.
/// </summary>
/// <param name="bytes">The binary data.</param>
/// <param name="subType">The binary data subtype.</param>
/// <param name="guidRepresentation">The representation for Guids.</param>
/// <returns>A BsonBinaryData or null.</returns>
public static BsonBinaryData Create(byte[] bytes, BsonBinarySubType subType, GuidRepresentation guidRepresentation)
{
if (bytes != null)
{
return new BsonBinaryData(bytes, subType, guidRepresentation);
}
else
{
return null;
}
}
/// <summary>
/// Creates a new BsonBinaryData.
/// </summary>
/// <param name="guid">A Guid.</param>
/// <returns>A BsonBinaryData.</returns>
public static BsonBinaryData Create(Guid guid)
{
return new BsonBinaryData(guid);
}
/// <summary>
/// Creates a new BsonBinaryData.
/// </summary>
/// <param name="guid">A Guid.</param>
/// <param name="guidRepresentation">The representation for Guids.</param>
/// <returns>A BsonBinaryData.</returns>
public static BsonBinaryData Create(Guid guid, GuidRepresentation guidRepresentation)
{
return new BsonBinaryData(guid, guidRepresentation);
}
/// <summary>
/// Creates a new BsonBinaryData.
/// </summary>
/// <param name="value">An object to be mapped to a BsonBinaryData.</param>
/// <returns>A BsonBinaryData or null.</returns>
public new static BsonBinaryData Create(object value)
{
if (value != null)
{
return (BsonBinaryData)BsonTypeMapper.MapToBsonValue(value, BsonType.Binary);
}
else
{
return null;
}
}
// public methods
/// <summary>
/// Compares this BsonBinaryData to another BsonBinaryData.
/// </summary>
/// <param name="other">The other BsonBinaryData.</param>
/// <returns>A 32-bit signed integer that indicates whether this BsonBinaryData is less than, equal to, or greather than the other.</returns>
public int CompareTo(BsonBinaryData other)
{
if (other == null) { return 1; }
int r = _subType.CompareTo(other._subType);
if (r != 0) { return r; }
for (int i = 0; i < _bytes.Length && i < other._bytes.Length; i++)
{
r = _bytes[i].CompareTo(other._bytes[i]);
if (r != 0) { return r; }
}
return _bytes.Length.CompareTo(other._bytes.Length);
}
/// <summary>
/// Compares the BsonBinaryData to another BsonValue.
/// </summary>
/// <param name="other">The other BsonValue.</param>
/// <returns>A 32-bit signed integer that indicates whether this BsonBinaryData is less than, equal to, or greather than the other BsonValue.</returns>
public override int CompareTo(BsonValue other)
{
if (other == null) { return 1; }
var otherBinaryData = other as BsonBinaryData;
if (otherBinaryData != null)
{
return CompareTo(otherBinaryData);
}
return CompareTypeTo(other);
}
/// <summary>
/// Compares this BsonBinaryData to another BsonBinaryData.
/// </summary>
/// <param name="rhs">The other BsonBinaryData.</param>
/// <returns>True if the two BsonBinaryData values are equal.</returns>
public bool Equals(BsonBinaryData rhs)
{
if (object.ReferenceEquals(rhs, null) || GetType() != rhs.GetType()) { return false; }
// note: guidRepresentation is not considered when testing for Equality
return object.ReferenceEquals(this, rhs) || _subType == rhs._subType && _bytes.SequenceEqual(rhs._bytes);
}
/// <summary>
/// Compares this BsonBinaryData to another object.
/// </summary>
/// <param name="obj">The other object.</param>
/// <returns>True if the other object is a BsonBinaryData and equal to this one.</returns>
public override bool Equals(object obj)
{
return Equals(obj as BsonBinaryData); // works even if obj is null or of a different type
}
/// <summary>
/// Gets the hash code.
/// </summary>
/// <returns>The hash code.</returns>
public override int GetHashCode()
{
// see Effective Java by Joshua Bloch
// note: guidRepresentation is not considered when computing the hash code
int hash = 17;
hash = 37 * hash + _bsonType.GetHashCode();
foreach (byte b in _bytes)
{
hash = 37 * hash + b;
}
hash = 37 * hash + _subType.GetHashCode();
return hash;
}
/// <summary>
/// Converts this BsonBinaryData to a Guid.
/// </summary>
/// <returns>A Guid.</returns>
public Guid ToGuid()
{
return ToGuid(_guidRepresentation);
}
/// <summary>
/// Converts this BsonBinaryData to a Guid.
/// </summary>
/// <param name="guidRepresentation">The representation for Guids.</param>
/// <returns>A Guid.</returns>
public Guid ToGuid(GuidRepresentation guidRepresentation)
{
if (_subType != BsonBinarySubType.UuidStandard && _subType != BsonBinarySubType.UuidLegacy)
{
var message = string.Format("SubType must be UuidStandard or UuidLegacy, not {0}.", _subType);
throw new InvalidOperationException(message);
}
if (guidRepresentation == GuidRepresentation.Unspecified)
{
throw new ArgumentException("GuidRepresentation cannot be Unspecified.");
}
return GuidConverter.FromBytes(_bytes, guidRepresentation);
}
/// <summary>
/// Returns a string representation of the binary data.
/// </summary>
/// <returns>A string representation of the binary data.</returns>
public override string ToString()
{
return string.Format("{0}:0x{1}", _subType, BsonUtils.ToHexString(_bytes));
}
}
}