-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
CursorBatch.cs
94 lines (87 loc) · 3.01 KB
/
CursorBatch.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
/* Copyright 2013-present MongoDB 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.Collections.Generic;
using MongoDB.Bson;
using MongoDB.Driver.Core.Misc;
namespace MongoDB.Driver.Core.WireProtocol
{
/// <summary>
/// Represents one result batch (returned from either a Query or a GetMore message)
/// </summary>
/// <typeparam name="TDocument">The type of the document.</typeparam>
public struct CursorBatch<TDocument>
{
// fields
private readonly long _cursorId;
private readonly IReadOnlyList<TDocument> _documents;
private readonly BsonDocument _postBatchResumeToken;
// constructors
/// <summary>
/// Initializes a new instance of the <see cref="CursorBatch{TDocument}"/> struct.
/// </summary>
/// <param name="cursorId">The cursor identifier.</param>
/// <param name="postBatchResumeToken">The post batch resume token.</param>
/// <param name="documents">The documents.</param>
public CursorBatch(
long cursorId,
BsonDocument postBatchResumeToken,
IReadOnlyList<TDocument> documents)
{
_cursorId = cursorId;
_postBatchResumeToken = postBatchResumeToken;
_documents = Ensure.IsNotNull(documents, nameof(documents));
}
/// <summary>
/// Initializes a new instance of the <see cref="CursorBatch{TDocument}"/> struct.
/// </summary>
/// <param name="cursorId">The cursor identifier.</param>
/// <param name="documents">The documents.</param>
public CursorBatch(long cursorId, IReadOnlyList<TDocument> documents)
: this(cursorId, null, documents)
{
}
// properties
/// <summary>
/// Gets the cursor identifier.
/// </summary>
/// <value>
/// The cursor identifier.
/// </value>
public long CursorId
{
get { return _cursorId; }
}
/// <summary>
/// Gets the documents.
/// </summary>
/// <value>
/// The documents.
/// </value>
public IReadOnlyList<TDocument> Documents
{
get { return _documents; }
}
/// <summary>
/// Gets the post batch resume token.
/// </summary>
/// <value>
/// The post batch resume token.
/// </value>
public BsonDocument PostBatchResumeToken
{
get { return _postBatchResumeToken; }
}
}
}