|
19 | 19 | Singleton empty <see cref="T:System.Byte"/>[]. |
20 | 20 | </summary> |
21 | 21 | </member> |
| 22 | + <member name="T:MsgPack.BufferManager"> |
| 23 | + <summary> |
| 24 | + Manages internal thread-local buffers for packer/unpacker. |
| 25 | + </summary> |
| 26 | + </member> |
22 | 27 | <member name="T:MsgPack.CollectionDebuggerProxy`1"> |
23 | 28 | <summary> |
24 | 29 | Debugger type proxy for <see cref="T:System.Collections.Generic.ICollection`1"/>. |
|
191 | 196 | Implements deserializing feature of MsgPack. |
192 | 197 | </summary> |
193 | 198 | <remarks name="MsgPack.Unpacker"> |
194 | | - <see cref="T:MsgPack.Unpacker"/> implements three mode, that is 'Streaming', 'Enumerating', 'Skipping', and 'Subtree'. |
| 199 | + <see cref="T:MsgPack.Unpacker"/> implements three mode, that is 'Streaming', 'Skipping' and 'Subtree'. |
195 | 200 | <list type="bullet"> |
196 | 201 | <item> |
197 | 202 | <para> |
|
208 | 213 | If the reading of the entry is completed, that is the <see cref="P:MsgPack.Unpacker.Data"/> is not <c>null</c>, unpacker can transit other mode. |
209 | 214 | </para> |
210 | 215 | </item> |
211 | | - <item> |
212 | | - <para> |
213 | | - <strong>Enumerating</strong> |
214 | | - </para> |
215 | | - <para> |
216 | | - When the <see cref="M:MsgPack.Unpacker.GetEnumerator"/> is called and the enumeration is started, unpacker go into 'Enumerating' mode. |
217 | | - In this mode, unpacker unpacks individual entries as <see cref="T:MsgPack.MessagePackObject"/> via <see cref="P:IEnumerator{T}.Current"/> property. |
218 | | - If the underlying stream is ended unexpectedly, enumeration is interrupted. |
219 | | - The interrupted unpacker cannot be resume. |
220 | | - </para> |
221 | | - <para> |
222 | | - Once the enumeration is completed gracefully, unpacker can transit other mode. |
223 | | - </para> |
224 | | - </item> |
225 | 216 | <item> |
226 | 217 | <para> |
227 | 218 | <strong>Skipping</strong> |
|
282 | 273 | Verifies this instance is not disposed. |
283 | 274 | </summary> |
284 | 275 | </member> |
285 | | - <member name="M:MsgPack.Unpacker.NewInvalidModeException"> |
286 | | - <summary> |
287 | | - Returns new exception instance to notify invalid mode transition. |
288 | | - </summary> |
289 | | - <returns>New exception instance to notify invalid mode transition.</returns> |
290 | | - </member> |
291 | 276 | <member name="M:MsgPack.Unpacker.Create(System.IO.Stream)"> |
292 | 277 | <summary> |
293 | 278 | Creates the new <see cref="T:MsgPack.Unpacker"/> from specified stream. |
|
982 | 967 | This instance does not supoort direct API. |
983 | 968 | </exception> |
984 | 969 | </member> |
| 970 | + <member name="F:MsgPack.ItemsUnpacker._offset"> |
| 971 | + <summary> |
| 972 | + An position of seekable <see cref="T:System.IO.Stream"/> or offset from start of this instance. |
| 973 | + </summary> |
| 974 | + </member> |
985 | 975 | <member name="M:MsgPack.ItemsUnpacker.ReadSubtreeCore"> |
986 | 976 | <summary> |
987 | 977 | Starts unpacking of current subtree. |
|
7450 | 7440 | <c>true</c> if prefer reflection based collection serializers instead of dyhnamic generated serializers; otherwise, <c>false</c>. |
7451 | 7441 | </value> |
7452 | 7442 | </member> |
| 7443 | + <member name="P:MsgPack.Serialization.ISerializerGeneratorConfiguration.WithNullableSerializers"> |
| 7444 | + <summary> |
| 7445 | + Gets or sets a value indicating whether creating Nullable of T serializers for value type serializers. |
| 7446 | + </summary> |
| 7447 | + <value> |
| 7448 | + <c>true</c> if creates Nullable of T serializers for value type serializers; otherwise, <c>false</c>. |
| 7449 | + </value> |
| 7450 | + </member> |
7453 | 7451 | <member name="T:MsgPack.Serialization.LazyDelegatingMessagePackSerializer`1"> |
7454 | 7452 | <summary> |
7455 | 7453 | Lazy initialized serializer which delegates actual work for the other serializer implementation. |
|
9437 | 9435 | </member> |
9438 | 9436 | <member name="M:MsgPack.Serialization.SerializationContext.#ctor(MsgPack.PackerCompatibilityOptions)"> |
9439 | 9437 | <summary> |
9440 | | - Initializes a new instance of the <see cref="T:MsgPack.Serialization.SerializationContext"/> class with copy of <see cref="M:MsgPack.Serialization.SerializerRepository.GetDefault(MsgPack.PackerCompatibilityOptions)"/> for specified <see cref="T:MsgPack.PackerCompatibilityOptions"/>. |
| 9438 | + Initializes a new instance of the <see cref="T:MsgPack.Serialization.SerializationContext"/> class with copy of <see cref="M:MsgPack.Serialization.SerializerRepository.GetDefault"/> for specified <see cref="T:MsgPack.PackerCompatibilityOptions"/>. |
9441 | 9439 | </summary> |
9442 | 9440 | <param name="packerCompatibilityOptions"><see cref="T:MsgPack.PackerCompatibilityOptions"/> which will be used on built-in serializers.</param> |
9443 | 9441 | </member> |
|
9961 | 9959 | <c>true</c> if prefer reflection based collection serializers instead of dyhnamic generated serializers; otherwise, <c>false</c>. |
9962 | 9960 | </value> |
9963 | 9961 | </member> |
| 9962 | + <member name="P:MsgPack.Serialization.SerializerAssemblyGenerationConfiguration.WithNullableSerializers"> |
| 9963 | + <summary> |
| 9964 | + Gets or sets a value indicating whether creating Nullable of T serializers for value type serializers. |
| 9965 | + </summary> |
| 9966 | + <value> |
| 9967 | + <c>true</c> if creates Nullable of T serializers for value type serializers; otherwise, <c>false</c>. |
| 9968 | + </value> |
| 9969 | + </member> |
9964 | 9970 | <member name="T:MsgPack.Serialization.SerializerCodeGenerationConfiguration"> |
9965 | 9971 | <summary> |
9966 | 9972 | Represents configuration for serializer code generation. |
|
10054 | 10060 | <c>true</c> if prefer reflection based collection serializers instead of dyhnamic generated serializers; otherwise, <c>false</c>. |
10055 | 10061 | </value> |
10056 | 10062 | </member> |
| 10063 | + <member name="P:MsgPack.Serialization.SerializerCodeGenerationConfiguration.WithNullableSerializers"> |
| 10064 | + <summary> |
| 10065 | + Gets or sets a value indicating whether creating Nullable of T serializers for value type serializers. |
| 10066 | + </summary> |
| 10067 | + <value> |
| 10068 | + <c>true</c> if creates Nullable of T serializers for value type serializers; otherwise, <c>false</c>. |
| 10069 | + </value> |
| 10070 | + </member> |
10057 | 10071 | <member name="P:MsgPack.Serialization.SerializerCodeGenerationConfiguration.IsInternalToMsgPackLibrary"> |
10058 | 10072 | <summary> |
10059 | 10073 | Gets or sets a value indicating whether the generated serializers will be internal to MsgPack library itself. |
|
10448 | 10462 | The <see cref="T:MsgPack.Serialization.SerializationMethod"/> which indicates serialization method to be used. |
10449 | 10463 | </value> |
10450 | 10464 | </member> |
| 10465 | + <member name="T:MsgPack.Serialization.SerializerRegistrationOptions"> |
| 10466 | + <summary> |
| 10467 | + Represents options for custom or pre-generated serializer registration. |
| 10468 | + </summary> |
| 10469 | + </member> |
| 10470 | + <member name="F:MsgPack.Serialization.SerializerRegistrationOptions.None"> |
| 10471 | + <summary> |
| 10472 | + None of options are applied. |
| 10473 | + </summary> |
| 10474 | + </member> |
| 10475 | + <member name="F:MsgPack.Serialization.SerializerRegistrationOptions.AllowOverride"> |
| 10476 | + <summary> |
| 10477 | + Overrides existing registration with specified serializer. |
| 10478 | + </summary> |
| 10479 | + </member> |
| 10480 | + <member name="F:MsgPack.Serialization.SerializerRegistrationOptions.WithNullable"> |
| 10481 | + <summary> |
| 10482 | + For non-nullable value type, registering nullable companion simulary. |
| 10483 | + </summary> |
| 10484 | + </member> |
10451 | 10485 | <member name="T:MsgPack.Serialization.SerializerRepository"> |
10452 | 10486 | <summary> |
10453 | 10487 | Repository of known <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>s. |
|
10506 | 10540 | <exception cref="T:System.ArgumentNullException"> |
10507 | 10541 | <paramref name="serializer"/> is <c>null</c>. |
10508 | 10542 | </exception> |
| 10543 | + <remarks> |
| 10544 | + This method invokes <see cref="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0},MsgPack.Serialization.SerializerRegistrationOptions)"/> with <see cref="F:MsgPack.Serialization.SerializerRegistrationOptions.None"/>. |
| 10545 | + <note> |
| 10546 | + If you register serializer for value type, using <see cref="F:MsgPack.Serialization.SerializerRegistrationOptions.WithNullable"/> is recommended because auto-generated deserializers use them to handle nil value. |
| 10547 | + You can use <see cref="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0},MsgPack.Serialization.SerializerRegistrationOptions)"/> with <see cref="F:MsgPack.Serialization.SerializerRegistrationOptions.WithNullable"/> to |
| 10548 | + get equivalant behavior for this method with registering nullable serializer automatically. |
| 10549 | + </note> |
| 10550 | + </remarks> |
| 10551 | + </member> |
| 10552 | + <member name="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0},MsgPack.Serialization.SerializerRegistrationOptions)"> |
| 10553 | + <summary> |
| 10554 | + Registers a <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>. |
| 10555 | + </summary> |
| 10556 | + <typeparam name="T">The type of serialization target.</typeparam> |
| 10557 | + <param name="serializer"><see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance.</param> |
| 10558 | + <param name="options">A <see cref="T:MsgPack.Serialization.SerializerRegistrationOptions"/> to control this registration process.</param> |
| 10559 | + <returns> |
| 10560 | + <c>true</c> if success to register; otherwise, <c>false</c>. |
| 10561 | + </returns> |
| 10562 | + <exception cref="T:System.ArgumentNullException"> |
| 10563 | + <paramref name="serializer"/> is <c>null</c>. |
| 10564 | + </exception> |
10509 | 10565 | </member> |
10510 | 10566 | <member name="M:MsgPack.Serialization.SerializerRepository.RegisterOverride``1(MsgPack.Serialization.MessagePackSerializer{``0})"> |
10511 | 10567 | <summary> |
|
10516 | 10572 | <exception cref="T:System.ArgumentNullException"> |
10517 | 10573 | <paramref name="serializer"/> is <c>null</c>. |
10518 | 10574 | </exception> |
| 10575 | + <remarks> |
| 10576 | + This method invokes <see cref="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0},MsgPack.Serialization.SerializerRegistrationOptions)"/> with <see cref="F:MsgPack.Serialization.SerializerRegistrationOptions.AllowOverride"/>. |
| 10577 | + <note> |
| 10578 | + If you register serializer for value type, using <see cref="F:MsgPack.Serialization.SerializerRegistrationOptions.WithNullable"/> is recommended because auto-generated deserializers use them to handle nil value. |
| 10579 | + You can use <see cref="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0},MsgPack.Serialization.SerializerRegistrationOptions)"/> |
| 10580 | + with <see cref="F:MsgPack.Serialization.SerializerRegistrationOptions.AllowOverride"/> and <see cref="F:MsgPack.Serialization.SerializerRegistrationOptions.WithNullable"/> to |
| 10581 | + get equivalant behavior for this method with registering nullable serializer automatically. |
| 10582 | + </note> |
| 10583 | + </remarks> |
10519 | 10584 | </member> |
10520 | 10585 | <member name="M:MsgPack.Serialization.SerializerRepository.GetDefault"> |
10521 | 10586 | <summary> |
|
0 commit comments