Newtonsoft.Json.Bson.xml 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Newtonsoft.Json.Bson</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Newtonsoft.Json.Bson.BsonDataObjectId">
  8. <summary>
  9. Represents a BSON Oid (object id).
  10. </summary>
  11. </member>
  12. <member name="P:Newtonsoft.Json.Bson.BsonDataObjectId.Value">
  13. <summary>
  14. Gets or sets the value of the Oid.
  15. </summary>
  16. <value>The value of the Oid.</value>
  17. </member>
  18. <member name="M:Newtonsoft.Json.Bson.BsonDataObjectId.#ctor(System.Byte[])">
  19. <summary>
  20. Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonDataObjectId"/> class.
  21. </summary>
  22. <param name="value">The Oid value.</param>
  23. </member>
  24. <member name="T:Newtonsoft.Json.Bson.BsonDataReader">
  25. <summary>
  26. Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data.
  27. </summary>
  28. </member>
  29. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsync(System.Threading.CancellationToken)">
  30. <summary>
  31. Asynchronously reads the next JSON token from the source.
  32. </summary>
  33. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  34. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  35. property returns <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.</returns>
  36. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  37. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  38. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  39. </member>
  40. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsBooleanAsync(System.Threading.CancellationToken)">
  41. <summary>
  42. Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Boolean" />.
  43. </summary>
  44. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  45. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  46. property returns the <see cref="T:System.Nullable`1" /> of <see cref="T:System.Boolean" />. This result will be <c>null</c> at the end of an array.</returns>
  47. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  48. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  49. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  50. </member>
  51. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsBytesAsync(System.Threading.CancellationToken)">
  52. <summary>
  53. Asynchronously reads the next JSON token from the source as a <see cref="T:System.Byte" />[].
  54. </summary>
  55. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  56. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  57. property returns the <see cref="T:System.Byte" />[]. This result will be <c>null</c> at the end of an array.</returns>
  58. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  59. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  60. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  61. </member>
  62. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsDateTimeAsync(System.Threading.CancellationToken)">
  63. <summary>
  64. Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTime" />.
  65. </summary>
  66. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  67. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  68. property returns the <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTime" />. This result will be <c>null</c> at the end of an array.</returns>
  69. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  70. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  71. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  72. </member>
  73. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsDateTimeOffsetAsync(System.Threading.CancellationToken)">
  74. <summary>
  75. Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTimeOffset" />.
  76. </summary>
  77. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  78. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  79. property returns the <see cref="T:System.Nullable`1" /> of <see cref="T:System.DateTimeOffset" />. This result will be <c>null</c> at the end of an array.</returns>
  80. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  81. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  82. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  83. </member>
  84. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsDecimalAsync(System.Threading.CancellationToken)">
  85. <summary>
  86. Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Decimal" />.
  87. </summary>
  88. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  89. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  90. property returns the <see cref="T:System.Nullable`1" /> of <see cref="T:System.Decimal" />. This result will be <c>null</c> at the end of an array.</returns>
  91. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  92. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  93. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  94. </member>
  95. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsDoubleAsync(System.Threading.CancellationToken)">
  96. <summary>
  97. Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Double" />.
  98. </summary>
  99. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  100. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  101. property returns the <see cref="T:System.Nullable`1" /> of <see cref="T:System.Double" />. This result will be <c>null</c> at the end of an array.</returns>
  102. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  103. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  104. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  105. </member>
  106. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsInt32Async(System.Threading.CancellationToken)">
  107. <summary>
  108. Asynchronously reads the next JSON token from the source as a <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int32" />.
  109. </summary>
  110. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  111. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  112. property returns the <see cref="T:System.Nullable`1" /> of <see cref="T:System.Int32" />. This result will be <c>null</c> at the end of an array.</returns>
  113. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  114. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  115. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  116. </member>
  117. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.ReadAsStringAsync(System.Threading.CancellationToken)">
  118. <summary>
  119. Asynchronously reads the next JSON token from the source as a <see cref="T:System.String" />.
  120. </summary>
  121. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  122. <returns>A <see cref="T:System.Threading.Tasks.Task`1" /> that represents the asynchronous read. The <see cref="P:System.Threading.Tasks.Task`1.Result" />
  123. property returns the <see cref="T:System.String" />. This result will be <c>null</c> at the end of an array.</returns>
  124. <remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it will
  125. execute synchronously, returning an already-completed task. Asynchronous behaviour is also not available when the
  126. constructor was passed an instance of type derived from <see cref="T:System.IO.BinaryReader"/>.</remarks>
  127. </member>
  128. <member name="P:Newtonsoft.Json.Bson.BsonDataReader.JsonNet35BinaryCompatibility">
  129. <summary>
  130. Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary.
  131. </summary>
  132. <value>
  133. <c>true</c> if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, <c>false</c>.
  134. </value>
  135. </member>
  136. <member name="P:Newtonsoft.Json.Bson.BsonDataReader.ReadRootValueAsArray">
  137. <summary>
  138. Gets or sets a value indicating whether the root object will be read as a JSON array.
  139. </summary>
  140. <value>
  141. <c>true</c> if the root object will be read as a JSON array; otherwise, <c>false</c>.
  142. </value>
  143. </member>
  144. <member name="P:Newtonsoft.Json.Bson.BsonDataReader.DateTimeKindHandling">
  145. <summary>
  146. Gets or sets the <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.
  147. </summary>
  148. <value>The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</value>
  149. </member>
  150. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.#ctor(System.IO.Stream)">
  151. <summary>
  152. Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonDataReader"/> class.
  153. </summary>
  154. <param name="stream">The <see cref="T:System.IO.Stream"/> containing the BSON data to read.</param>
  155. </member>
  156. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.#ctor(System.IO.BinaryReader)">
  157. <summary>
  158. Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonDataReader"/> class.
  159. </summary>
  160. <param name="reader">The <see cref="T:System.IO.BinaryReader"/> containing the BSON data to read.</param>
  161. </member>
  162. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.#ctor(System.IO.Stream,System.Boolean,System.DateTimeKind)">
  163. <summary>
  164. Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonDataReader"/> class.
  165. </summary>
  166. <param name="stream">The <see cref="T:System.IO.Stream"/> containing the BSON data to read.</param>
  167. <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param>
  168. <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param>
  169. </member>
  170. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.#ctor(System.IO.BinaryReader,System.Boolean,System.DateTimeKind)">
  171. <summary>
  172. Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonDataReader"/> class.
  173. </summary>
  174. <param name="reader">The <see cref="T:System.IO.BinaryReader"/> containing the BSON data to read.</param>
  175. <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param>
  176. <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param>
  177. </member>
  178. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.Read">
  179. <summary>
  180. Reads the next JSON token from the underlying <see cref="T:System.IO.Stream"/>.
  181. </summary>
  182. <returns>
  183. <c>true</c> if the next token was read successfully; <c>false</c> if there are no more tokens to read.
  184. </returns>
  185. </member>
  186. <member name="M:Newtonsoft.Json.Bson.BsonDataReader.Close">
  187. <summary>
  188. Changes the reader's state to <see cref="F:Newtonsoft.Json.JsonReader.State.Closed"/>.
  189. If <see cref="P:Newtonsoft.Json.JsonReader.CloseInput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.Stream"/> is also closed.
  190. </summary>
  191. </member>
  192. <member name="T:Newtonsoft.Json.Bson.BsonDataWriter">
  193. <summary>
  194. Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data.
  195. </summary>
  196. </member>
  197. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.FlushAsync(System.Threading.CancellationToken)">
  198. <summary>
  199. Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination.
  200. </summary>
  201. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
  202. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  203. <remarks>Because BSON documents are written as a single unit, only <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.FlushAsync(System.Threading.CancellationToken)"/>,
  204. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.CloseAsync(System.Threading.CancellationToken)"/> and the final <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndAsync(System.Threading.CancellationToken)"/>,
  205. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndArrayAsync(System.Threading.CancellationToken)"/> or <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndObjectAsync(System.Threading.CancellationToken)"/>
  206. that finishes writing the document will write asynchronously. Derived classes will not write asynchronously.</remarks>
  207. </member>
  208. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndAsync(System.Threading.CancellationToken)">
  209. <summary>
  210. Asynchronously writes the end of the current JSON object or array.
  211. </summary>
  212. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
  213. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  214. <remarks>Because BSON documents are written as a single unit, only <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.FlushAsync(System.Threading.CancellationToken)"/>,
  215. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.CloseAsync(System.Threading.CancellationToken)"/> and the final <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndAsync(System.Threading.CancellationToken)"/>,
  216. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndArrayAsync(System.Threading.CancellationToken)"/> or <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndObjectAsync(System.Threading.CancellationToken)"/>
  217. that finishes writing the document will write asynchronously. Derived classes will not write asynchronously.</remarks>
  218. </member>
  219. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndArrayAsync(System.Threading.CancellationToken)">
  220. <summary>
  221. Asynchronously writes the end of an array.
  222. </summary>
  223. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
  224. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  225. <remarks>Because BSON documents are written as a single unit, only <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.FlushAsync(System.Threading.CancellationToken)"/>,
  226. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.CloseAsync(System.Threading.CancellationToken)"/> and the final <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndAsync(System.Threading.CancellationToken)"/>,
  227. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndArrayAsync(System.Threading.CancellationToken)"/> or <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndObjectAsync(System.Threading.CancellationToken)"/>
  228. that finishes writing the document will write asynchronously. Derived classes will not write asynchronously.</remarks>
  229. </member>
  230. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndObjectAsync(System.Threading.CancellationToken)">
  231. <summary>
  232. Asynchronously writes the end of a JSON object.
  233. </summary>
  234. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
  235. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  236. <remarks>Because BSON documents are written as a single unit, only <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.FlushAsync(System.Threading.CancellationToken)"/>,
  237. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.CloseAsync(System.Threading.CancellationToken)"/> and the final <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndAsync(System.Threading.CancellationToken)"/>,
  238. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndArrayAsync(System.Threading.CancellationToken)"/> or <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndObjectAsync(System.Threading.CancellationToken)"/>
  239. that finishes writing the document will write asynchronously. Derived classes will not write asynchronously.</remarks>
  240. </member>
  241. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.CloseAsync(System.Threading.CancellationToken)">
  242. <summary>
  243. Asynchronously closes this writer.
  244. If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the destination is also closed.
  245. </summary>
  246. <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"/>.</param>
  247. <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the asynchronous operation.</returns>
  248. <remarks>Because BSON documents are written as a single unit, only <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.FlushAsync(System.Threading.CancellationToken)"/>,
  249. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.CloseAsync(System.Threading.CancellationToken)"/> and the final <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndAsync(System.Threading.CancellationToken)"/>,
  250. <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndArrayAsync(System.Threading.CancellationToken)"/> or <see cref="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEndObjectAsync(System.Threading.CancellationToken)"/>
  251. that finishes writing the document will write asynchronously. Derived classes will not write asynchronously.</remarks>
  252. </member>
  253. <member name="P:Newtonsoft.Json.Bson.BsonDataWriter.DateTimeKindHandling">
  254. <summary>
  255. Gets or sets the <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON.
  256. When set to <see cref="F:System.DateTimeKind.Unspecified" /> no conversion will occur.
  257. </summary>
  258. <value>The <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON.</value>
  259. </member>
  260. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.#ctor(System.IO.Stream)">
  261. <summary>
  262. Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonDataWriter"/> class.
  263. </summary>
  264. <param name="stream">The <see cref="T:System.IO.Stream"/> to write to.</param>
  265. </member>
  266. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.#ctor(System.IO.BinaryWriter)">
  267. <summary>
  268. Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonDataWriter"/> class.
  269. </summary>
  270. <param name="writer">The <see cref="T:System.IO.BinaryWriter"/> to write to.</param>
  271. </member>
  272. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.Flush">
  273. <summary>
  274. Flushes whatever is in the buffer to the underlying <see cref="T:System.IO.Stream"/> and also flushes the underlying stream.
  275. </summary>
  276. </member>
  277. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
  278. <summary>
  279. Writes the end.
  280. </summary>
  281. <param name="token">The token.</param>
  282. </member>
  283. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteComment(System.String)">
  284. <summary>
  285. Writes a comment <c>/*...*/</c> containing the specified text.
  286. </summary>
  287. <param name="text">Text to place inside the comment.</param>
  288. </member>
  289. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteStartConstructor(System.String)">
  290. <summary>
  291. Writes the start of a constructor with the given name.
  292. </summary>
  293. <param name="name">The name of the constructor.</param>
  294. </member>
  295. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteRaw(System.String)">
  296. <summary>
  297. Writes raw JSON.
  298. </summary>
  299. <param name="json">The raw JSON to write.</param>
  300. </member>
  301. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteRawValue(System.String)">
  302. <summary>
  303. Writes raw JSON where a value is expected and updates the writer's state.
  304. </summary>
  305. <param name="json">The raw JSON to write.</param>
  306. </member>
  307. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteStartArray">
  308. <summary>
  309. Writes the beginning of a JSON array.
  310. </summary>
  311. </member>
  312. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteStartObject">
  313. <summary>
  314. Writes the beginning of a JSON object.
  315. </summary>
  316. </member>
  317. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WritePropertyName(System.String)">
  318. <summary>
  319. Writes the property name of a name/value pair on a JSON object.
  320. </summary>
  321. <param name="name">The name of the property.</param>
  322. </member>
  323. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.Close">
  324. <summary>
  325. Closes this writer.
  326. If <see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/> is set to <c>true</c>, the underlying <see cref="T:System.IO.Stream"/> is also closed.
  327. If <see cref="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose"/> is set to <c>true</c>, the JSON is auto-completed.
  328. </summary>
  329. </member>
  330. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Object)">
  331. <summary>
  332. Writes a <see cref="T:System.Object"/> value.
  333. An error will raised if the value cannot be written as a single JSON token.
  334. </summary>
  335. <param name="value">The <see cref="T:System.Object"/> value to write.</param>
  336. </member>
  337. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteNull">
  338. <summary>
  339. Writes a null value.
  340. </summary>
  341. </member>
  342. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteUndefined">
  343. <summary>
  344. Writes an undefined value.
  345. </summary>
  346. </member>
  347. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.String)">
  348. <summary>
  349. Writes a <see cref="T:System.String"/> value.
  350. </summary>
  351. <param name="value">The <see cref="T:System.String"/> value to write.</param>
  352. </member>
  353. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Int32)">
  354. <summary>
  355. Writes a <see cref="T:System.Int32"/> value.
  356. </summary>
  357. <param name="value">The <see cref="T:System.Int32"/> value to write.</param>
  358. </member>
  359. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.UInt32)">
  360. <summary>
  361. Writes a <see cref="T:System.UInt32"/> value.
  362. </summary>
  363. <param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
  364. </member>
  365. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Int64)">
  366. <summary>
  367. Writes a <see cref="T:System.Int64"/> value.
  368. </summary>
  369. <param name="value">The <see cref="T:System.Int64"/> value to write.</param>
  370. </member>
  371. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.UInt64)">
  372. <summary>
  373. Writes a <see cref="T:System.UInt64"/> value.
  374. </summary>
  375. <param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
  376. </member>
  377. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Single)">
  378. <summary>
  379. Writes a <see cref="T:System.Single"/> value.
  380. </summary>
  381. <param name="value">The <see cref="T:System.Single"/> value to write.</param>
  382. </member>
  383. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Double)">
  384. <summary>
  385. Writes a <see cref="T:System.Double"/> value.
  386. </summary>
  387. <param name="value">The <see cref="T:System.Double"/> value to write.</param>
  388. </member>
  389. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Boolean)">
  390. <summary>
  391. Writes a <see cref="T:System.Boolean"/> value.
  392. </summary>
  393. <param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
  394. </member>
  395. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Int16)">
  396. <summary>
  397. Writes a <see cref="T:System.Int16"/> value.
  398. </summary>
  399. <param name="value">The <see cref="T:System.Int16"/> value to write.</param>
  400. </member>
  401. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.UInt16)">
  402. <summary>
  403. Writes a <see cref="T:System.UInt16"/> value.
  404. </summary>
  405. <param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
  406. </member>
  407. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Char)">
  408. <summary>
  409. Writes a <see cref="T:System.Char"/> value.
  410. </summary>
  411. <param name="value">The <see cref="T:System.Char"/> value to write.</param>
  412. </member>
  413. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Byte)">
  414. <summary>
  415. Writes a <see cref="T:System.Byte"/> value.
  416. </summary>
  417. <param name="value">The <see cref="T:System.Byte"/> value to write.</param>
  418. </member>
  419. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.SByte)">
  420. <summary>
  421. Writes a <see cref="T:System.SByte"/> value.
  422. </summary>
  423. <param name="value">The <see cref="T:System.SByte"/> value to write.</param>
  424. </member>
  425. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Decimal)">
  426. <summary>
  427. Writes a <see cref="T:System.Decimal"/> value.
  428. </summary>
  429. <param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
  430. </member>
  431. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.DateTime)">
  432. <summary>
  433. Writes a <see cref="T:System.DateTime"/> value.
  434. </summary>
  435. <param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
  436. </member>
  437. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.DateTimeOffset)">
  438. <summary>
  439. Writes a <see cref="T:System.DateTimeOffset"/> value.
  440. </summary>
  441. <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
  442. </member>
  443. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Byte[])">
  444. <summary>
  445. Writes a <see cref="T:System.Byte"/>[] value.
  446. </summary>
  447. <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
  448. </member>
  449. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Guid)">
  450. <summary>
  451. Writes a <see cref="T:System.Guid"/> value.
  452. </summary>
  453. <param name="value">The <see cref="T:System.Guid"/> value to write.</param>
  454. </member>
  455. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.TimeSpan)">
  456. <summary>
  457. Writes a <see cref="T:System.TimeSpan"/> value.
  458. </summary>
  459. <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
  460. </member>
  461. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteValue(System.Uri)">
  462. <summary>
  463. Writes a <see cref="T:System.Uri"/> value.
  464. </summary>
  465. <param name="value">The <see cref="T:System.Uri"/> value to write.</param>
  466. </member>
  467. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteObjectId(System.Byte[])">
  468. <summary>
  469. Writes a <see cref="T:System.Byte"/>[] value that represents a BSON object id.
  470. </summary>
  471. <param name="value">The Object ID value to write.</param>
  472. </member>
  473. <member name="M:Newtonsoft.Json.Bson.BsonDataWriter.WriteRegex(System.String,System.String)">
  474. <summary>
  475. Writes a BSON regex.
  476. </summary>
  477. <param name="pattern">The regex pattern.</param>
  478. <param name="options">The regex options.</param>
  479. </member>
  480. <member name="T:Newtonsoft.Json.Bson.Converters.BsonDataObjectIdConverter">
  481. <summary>
  482. Converts a <see cref="T:Newtonsoft.Json.Bson.BsonDataObjectId"/> to and from JSON and BSON.
  483. </summary>
  484. </member>
  485. <member name="M:Newtonsoft.Json.Bson.Converters.BsonDataObjectIdConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
  486. <summary>
  487. Writes the JSON representation of the object.
  488. </summary>
  489. <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
  490. <param name="value">The value.</param>
  491. <param name="serializer">The calling serializer.</param>
  492. </member>
  493. <member name="M:Newtonsoft.Json.Bson.Converters.BsonDataObjectIdConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
  494. <summary>
  495. Reads the JSON representation of the object.
  496. </summary>
  497. <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
  498. <param name="objectType">Type of the object.</param>
  499. <param name="existingValue">The existing value of object being read.</param>
  500. <param name="serializer">The calling serializer.</param>
  501. <returns>The object value.</returns>
  502. </member>
  503. <member name="M:Newtonsoft.Json.Bson.Converters.BsonDataObjectIdConverter.CanConvert(System.Type)">
  504. <summary>
  505. Determines whether this instance can convert the specified object type.
  506. </summary>
  507. <param name="objectType">Type of the object.</param>
  508. <returns>
  509. <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
  510. </returns>
  511. </member>
  512. <member name="T:Newtonsoft.Json.Bson.Converters.BsonDataRegexConverter">
  513. <summary>
  514. Converts a <see cref="T:System.Text.RegularExpressions.Regex"/> to and from BSON.
  515. </summary>
  516. </member>
  517. <member name="M:Newtonsoft.Json.Bson.Converters.BsonDataRegexConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
  518. <summary>
  519. Writes the JSON representation of the object.
  520. </summary>
  521. <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
  522. <param name="value">The value.</param>
  523. <param name="serializer">The calling serializer.</param>
  524. </member>
  525. <member name="M:Newtonsoft.Json.Bson.Converters.BsonDataRegexConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
  526. <summary>
  527. Reads the JSON representation of the object.
  528. </summary>
  529. <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
  530. <param name="objectType">Type of the object.</param>
  531. <param name="existingValue">The existing value of object being read.</param>
  532. <param name="serializer">The calling serializer.</param>
  533. <returns>The object value.</returns>
  534. </member>
  535. <member name="M:Newtonsoft.Json.Bson.Converters.BsonDataRegexConverter.CanConvert(System.Type)">
  536. <summary>
  537. Determines whether this instance can convert the specified object type.
  538. </summary>
  539. <param name="objectType">Type of the object.</param>
  540. <returns>
  541. <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
  542. </returns>
  543. </member>
  544. </members>
  545. </doc>