10474 lines
590 KiB
XML
10474 lines
590 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>MsgPack</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:MsgPack.BigEndianBinary">
|
|
<summary>
|
|
Define bit operations which enforce big endian.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Binary">
|
|
<summary>
|
|
Defines binary related utilities.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Binary.Empty">
|
|
<summary>
|
|
Singleton empty <see cref="T:System.Byte"/>[].
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.CollectionDebuggerProxy`1">
|
|
<summary>
|
|
Debugger type proxy for <see cref="T:System.Collections.Generic.ICollection`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The element type of the collection.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.DictionaryDebuggerProxy`2">
|
|
<summary>
|
|
Debugger type proxy for <see cref="T:System.Collections.Generic.IDictionary`2"/>.
|
|
</summary>
|
|
<typeparam name="TKey">The key type of the dictionary.</typeparam>
|
|
<typeparam name="TValue">The value type of the dictionary.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Float32Bits">
|
|
<summary>
|
|
Provides bit access for <see cref="T:System.Single"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float32Bits.Value">
|
|
<summary>
|
|
Value as <see cref="T:System.Single"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float32Bits.Byte0">
|
|
<summary>
|
|
Most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float32Bits.Byte1">
|
|
<summary>
|
|
2nd bit from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float32Bits.Byte2">
|
|
<summary>
|
|
3rd byte from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float32Bits.Byte3">
|
|
<summary>
|
|
Least byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Float32Bits.#ctor(System.Single)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Float32Bits"/> type from specified <see cref="T:System.Single"/>.
|
|
</summary>
|
|
<param name="value">Value of <see cref="T:System.Single"/>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Float32Bits.#ctor(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Float32Bits"/> type from specified <see cref="T:System.Byte"/>[] which is big endian.
|
|
</summary>
|
|
<param name="bigEndianBytes">Array of <see cref="T:System.Byte"/> which contains bytes in big endian.</param>
|
|
<param name="offset">Offset to read.</param>
|
|
</member>
|
|
<member name="T:MsgPack.Float64Bits">
|
|
<summary>
|
|
Provides bit access for <see cref="T:System.Double"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Value">
|
|
<summary>
|
|
Value as <see cref="T:System.Double"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte0">
|
|
<summary>
|
|
Most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte1">
|
|
<summary>
|
|
2nd bit from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte2">
|
|
<summary>
|
|
3rd byte from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte3">
|
|
<summary>
|
|
4th byte from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte4">
|
|
<summary>
|
|
5th byte from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte5">
|
|
<summary>
|
|
6th byte from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte6">
|
|
<summary>
|
|
7th byte from most significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Float64Bits.Byte7">
|
|
<summary>
|
|
Least significant byte of current endian.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Float64Bits.#ctor(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Float64Bits"/> type from specified <see cref="T:System.Byte"/>[] which is big endian.
|
|
</summary>
|
|
<param name="bigEndianBytes">Array of <see cref="T:System.Byte"/> which contains bytes in big endian.</param>
|
|
<param name="offset">Offset to read.</param>
|
|
</member>
|
|
<member name="T:MsgPack.InvalidMessagePackStreamException">
|
|
<summary>
|
|
Exception occured when inbound stream is invalid as serialized Message Pack stream.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.InvalidMessagePackStreamException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.InvalidMessagePackStreamException"/> class with the default error message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.InvalidMessagePackStreamException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.InvalidMessagePackStreamException"/> class with a specified error message.
|
|
</summary>
|
|
<param name="message">The message that describes the error. </param>
|
|
</member>
|
|
<member name="M:MsgPack.InvalidMessagePackStreamException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.InvalidMessagePackStreamException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception. </param>
|
|
<param name="inner">
|
|
The exception that is the cause of the current exception, or a <c>null</c> if no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="T:MsgPack.IPackable">
|
|
<summary>
|
|
Represents objects which knows how to pack ifself using specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.IPackable.PackToMessage(MsgPack.Packer,MsgPack.PackingOptions)">
|
|
<summary>
|
|
Pack this instance itself using specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
<param name="packer"><see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="options">Packing options. This value can be null.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="packer"/> is null.</exception>
|
|
</member>
|
|
<member name="T:MsgPack.Unpacker">
|
|
<summary>
|
|
Implements deserializing feature of MsgPack.
|
|
</summary>
|
|
<remarks name="MsgPack.Unpacker">
|
|
<see cref="T:MsgPack.Unpacker"/> implements three mode, that is 'Streaming', 'Enumerating', 'Skipping', and 'Subtree'.
|
|
<list type="bullet">
|
|
<item>
|
|
<para>
|
|
<strong>Streaming</strong>
|
|
</para>
|
|
<para>
|
|
When the <see cref="M:MsgPack.Unpacker.Read"/> is called, unpacker go into 'Streaming' mode.
|
|
In this mode, unpacker unpacks individual entries as <see cref="T:MsgPack.MessagePackObject"/> via <see cref="P:MsgPack.Unpacker.Data"/> property.
|
|
If the underlying stream is ended unexpectedly, then <see cref="M:MsgPack.Unpacker.Read"/> returns <c>false</c>, and <see cref="P:MsgPack.Unpacker.Data"/> will be <c>null</c>.
|
|
Note that if the underlying stream is feeded, that is the <see cref="P:Stream.Length"/> is expanded and its <see cref="P:Stream.Position"/> is not forwarded,
|
|
subsequent <see cref="M:MsgPack.Unpacker.Read"/> invocation will success, and <see cref="P:MsgPack.Unpacker.Data"/> is set as complete entry which reflects feeded binary.
|
|
</para>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<strong>Enumerating</strong>
|
|
</para>
|
|
<para>
|
|
When the <see cref="M:MsgPack.Unpacker.GetEnumerator"/> is called and the enumeration is started, unpacker go into 'Enumerating' mode.
|
|
In this mode, unpacker unpacks individual entries as <see cref="T:MsgPack.MessagePackObject"/> via <see cref="P:IEnumerator{T}.Current"/> property.
|
|
If the underlying stream is ended unexpectedly, enumeration is interrupted.
|
|
The interrupted unpacker cannot be resume.
|
|
</para>
|
|
<para>
|
|
Once the enumeration is completed gracefully, unpacker can transit other mode.
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<strong>Skipping</strong>
|
|
</para>
|
|
<para>
|
|
When the <see cref="M:MsgPack.Unpacker.Skip"/> is called, unpacker go into 'Skipping' mode.
|
|
In this mode, unpacker scans the subtree where the root is current item, then returns skipped byte length.
|
|
If the underlying stream is ended unexpectedly, it returns <c>null</c>.
|
|
Note that if the underlying stream is feeded, that is the <see cref="P:Stream.Length"/> is expanded and its <see cref="P:Stream.Position"/> is not forwarded,
|
|
subsequent <see cref="M:MsgPack.Unpacker.Skip"/> invocation will success, and returns length as complete entry which reflects feeded binary.
|
|
<note>
|
|
If the underlying <see cref="T:System.IO.Stream"/> is cannot be seeked (that is, <see cref="P:Stream.CanSeek"/> is <c>false</c>),
|
|
DO NOT use this method.
|
|
You can buffering the content via <see cref="T:System.IO.MemoryStream"/> instead, for example.
|
|
</note>
|
|
</para>
|
|
<para>
|
|
If the skipping of the subtree is completed, that is the return value is not <c>null</c>, unpacker can transit other mode.
|
|
</para>
|
|
</item>
|
|
<item>
|
|
<para>
|
|
<strong>Subtree</strong>
|
|
</para>
|
|
<para>
|
|
When the <see cref="M:MsgPack.Unpacker.ReadSubtree"/> is called, unpacker go into 'Subtree' mode.
|
|
In this mode, any operation for this unpacker instance is invalid.
|
|
Instead of use this instance itself, you can use subtree unpacker returned from <see cref="M:MsgPack.Unpacker.ReadSubtree"/>.
|
|
The subtree unpacker is the instance which scope is limited to the subtree where the root is the current entry when <see cref="M:MsgPack.Unpacker.ReadSubtree"/> is called.
|
|
The subtree unpacker also have its own mode and state.
|
|
<note>
|
|
<see cref="M:MsgPack.Unpacker.Dispose"/> of the subtree unpacker must be called to indicate subtree unpacking is gracefully completed.
|
|
When the extra entries are remained in the subtree, these will be skipped on the disposal process.
|
|
</note>
|
|
</para>
|
|
<para>
|
|
Once the subtree unpacking is completed gracefully, that is, <see cref="M:MsgPack.Unpacker.Dispose"/> on the subtree unpacker called, the parant unpacker can transit other mode.
|
|
</para>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
<seealso cref="T:MsgPack.Unpacking"/>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.VerifyMode(MsgPack.Unpacker.UnpackerMode)">
|
|
<summary>
|
|
Verifies the mode.
|
|
</summary>
|
|
<param name="mode">The mode to be.</param>
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Already disposed.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
Is in incompatible mode.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.VerifyIsNotDisposed">
|
|
<summary>
|
|
Verifies this instance is not disposed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.NewInvalidModeException">
|
|
<summary>
|
|
Returns new exception instance to notify invalid mode transition.
|
|
</summary>
|
|
<returns>New exception instance to notify invalid mode transition.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.Create(System.IO.Stream)">
|
|
<summary>
|
|
Creates the new <see cref="T:MsgPack.Unpacker"/> from specified stream.
|
|
</summary>
|
|
<param name="stream">The stream to be unpacked. This stream will be closed when <see cref="M:MsgPack.Packer.Dispose(System.Boolean)"/> is called.</param>
|
|
<returns><see cref="T:MsgPack.Unpacker"/> instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.Create(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Creates the new <see cref="T:MsgPack.Unpacker"/> from specified stream.
|
|
</summary>
|
|
<param name="stream">The stream to be unpacked.</param>
|
|
<param name="ownsStream">
|
|
<c>true</c> to close <paramref name="stream"/> when this instance is disposed;
|
|
<c>false</c>, otherwise.
|
|
</param>
|
|
<returns><see cref="T:MsgPack.Unpacker"/> instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Unpacker"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.Dispose">
|
|
<summary>
|
|
Releases all managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and optionally managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadSubtree">
|
|
<summary>
|
|
Starts unpacking of current subtree.
|
|
</summary>
|
|
<returns>
|
|
<see cref="T:MsgPack.Unpacker"/> to unpack current subtree.
|
|
This will not be <c>null</c>.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
This unpacker is not positioned on the header of array nor map.
|
|
Or this unpacker already returned <see cref="T:MsgPack.Unpacker"/> for subtree and it has not been closed yet.
|
|
</exception>
|
|
<remarks>
|
|
While subtree unpacker is used, this instance will be 'locked' (called 'subtree' mode) and be unavailable.
|
|
When you finish to unpack subtree, you must invoke <see cref="M:MsgPack.Unpacker.Dispose"/>,
|
|
or you faces <see cref="T:System.InvalidOperationException"/> when you use the parent instance.
|
|
Subtree unpacker can only unpack subtree, so you can handle collection deserialization easily.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadSubtreeCore">
|
|
<summary>
|
|
Starts unpacking of current subtree.
|
|
</summary>
|
|
<returns>
|
|
<see cref="T:MsgPack.Unpacker"/> to unpack current subtree.
|
|
This will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.EndReadSubtree">
|
|
<summary>
|
|
Ends the read subtree.
|
|
</summary>
|
|
<remarks>
|
|
This method only be called from subtree unpacker.
|
|
Custom subtree unpacker implementation must call this method from its <see cref="M:MsgPack.Unpacker.Dispose(System.Boolean)"/> method.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.Read">
|
|
<summary>
|
|
Reads next Message Pack entry.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c>, if position is sucessfully move to next entry;
|
|
<c>false</c>, if position reaches the tail of the Message Pack stream.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
This instance is in 'subtree' mode.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
The underying stream unexpectedly ended.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadCore">
|
|
<summary>
|
|
Reads next Message Pack entry.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c>, if position is sucessfully move to next entry;
|
|
<c>false</c>, if position reaches the tail of the Message Pack stream.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.GetEnumerator">
|
|
<summary>
|
|
Gets <see cref="T:System.Collections.Generic.IEnumerator`1"/> to enumerate <see cref="T:MsgPack.MessagePackObject"/> from source stream.
|
|
</summary>
|
|
<returns><see cref="T:System.Collections.Generic.IEnumerator`1"/> to enumerate <see cref="T:MsgPack.MessagePackObject"/> from source stream.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.Skip">
|
|
<summary>
|
|
Skips the subtree where the root is the current entry, and returns skipped byte length.
|
|
</summary>
|
|
<returns>
|
|
Skipped byte length.
|
|
If the subtree is not completed, then <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.SkipCore">
|
|
<summary>
|
|
Skips the subtree where the root is the current entry, and returns skipped byte length.
|
|
</summary>
|
|
<returns>
|
|
Skipped byte length.
|
|
If the subtree is not completed, then <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadItem">
|
|
<summary>
|
|
Gets a current item or collection as single <see cref="T:MsgPack.MessagePackObject"/> from the stream.
|
|
</summary>
|
|
<returns>
|
|
A read item or collection from the stream.
|
|
Or <c>null</c> when stream is ended.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadItemData">
|
|
<summary>
|
|
Gets a current item or collection as single <see cref="T:MsgPack.MessagePackObject"/> from the stream.
|
|
</summary>
|
|
<returns>
|
|
A read item or collection from the stream.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">The stream unexpectedly ends.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.UnpackSubtree">
|
|
<summary>
|
|
Unpacks current subtree and returns subtree root as array or map.
|
|
</summary>
|
|
<returns>
|
|
An unpacked array or map when current position is array or map header.
|
|
<c>null</c> when current position is not array nor map header.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.UnpackSubtreeData">
|
|
<summary>
|
|
Unpacks current subtree and returns subtree root as array or map.
|
|
</summary>
|
|
<returns>
|
|
An unpacked array or map when current position is array or map header.
|
|
Or <see cref="P:MsgPack.Unpacker.LastReadData"/> when current position is not array nor map header.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadBoolean(System.Boolean@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.Boolean"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.Boolean"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.Boolean"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableBoolean(System.Nullable{System.Boolean}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.Boolean"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.Boolean"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.Boolean"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadByte(System.Byte@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.Byte"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.Byte"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.Byte"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableByte(System.Nullable{System.Byte}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.Byte"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.Byte"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.Byte"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadSByte(System.SByte@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.SByte"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.SByte"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.SByte"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableSByte(System.Nullable{System.SByte}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.SByte"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.SByte"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.SByte"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadInt16(System.Int16@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.Int16"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.Int16"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.Int16"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableInt16(System.Nullable{System.Int16}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.Int16"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.Int16"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.Int16"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadUInt16(System.UInt16@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.UInt16"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.UInt16"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.UInt16"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableUInt16(System.Nullable{System.UInt16}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.UInt16"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.UInt16"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.UInt16"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadInt32(System.Int32@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.Int32"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.Int32"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.Int32"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableInt32(System.Nullable{System.Int32}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.Int32"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.Int32"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.Int32"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadUInt32(System.UInt32@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.UInt32"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.UInt32"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.UInt32"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableUInt32(System.Nullable{System.UInt32}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.UInt32"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.UInt32"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.UInt32"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadInt64(System.Int64@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.Int64"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.Int64"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.Int64"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableInt64(System.Nullable{System.Int64}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.Int64"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.Int64"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.Int64"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadUInt64(System.UInt64@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.UInt64"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.UInt64"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.UInt64"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableUInt64(System.Nullable{System.UInt64}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.UInt64"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.UInt64"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.UInt64"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadSingle(System.Single@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.Single"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.Single"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.Single"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableSingle(System.Nullable{System.Single}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.Single"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.Single"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.Single"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadDouble(System.Double@)">
|
|
<summary>
|
|
Reads next <see cref="T:System.Double"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:System.Double"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:System.Double"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableDouble(System.Nullable{System.Double}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:System.Double"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:System.Double"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:System.Double"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadMessagePackExtendedTypeObject(MsgPack.MessagePackExtendedTypeObject@)">
|
|
<summary>
|
|
Reads next <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadNullableMessagePackExtendedTypeObject(System.Nullable{MsgPack.MessagePackExtendedTypeObject}@)">
|
|
<summary>
|
|
Reads next nullable <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> value from current stream.
|
|
</summary>
|
|
<returns>
|
|
The nullable <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> value read from current data source successfully.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not compatible for the nullable <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadArrayLength(System.Int64@)">
|
|
<summary>
|
|
Reads next array length value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The array length read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not an array.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadMapLength(System.Int64@)">
|
|
<summary>
|
|
Reads next map length value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The map length read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not a map.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadBinary(System.Byte[]@)">
|
|
<summary>
|
|
Reads next byte array value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The byte array read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not a raw.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadString(System.String@)">
|
|
<summary>
|
|
Reads next utf-8 encoded string value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The decoded utf-8 encoded string read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
A value read from data source is not a raw.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacker.ReadObject(MsgPack.MessagePackObject@)">
|
|
<summary>
|
|
Reads next value from current stream.
|
|
</summary>
|
|
<param name="result">
|
|
The <see cref="T:MsgPack.MessagePackObject"/> which represents a value read from current stream to be stored when operation is succeeded.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if expected value was read from stream; <c>false</c> if no more data on the stream.
|
|
Note that this method throws exception for unexpected state. See exceptions section.
|
|
</returns>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Cannot read a value because the underlying stream unexpectedly ends.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.Unpacker.Data">
|
|
<summary>
|
|
Gets a last unpacked data.
|
|
</summary>
|
|
<value>A last unpacked data.</value>
|
|
<remarks>
|
|
<note class="warning">
|
|
In default implementation, this property never returning <c>null</c> even if it had not been unpacked any objects.
|
|
</note>
|
|
If you use any of direct APIs (methods which return non-<see cref="T:MsgPack.MessagePackObject"/>),
|
|
then this property to be invalidated.
|
|
Note that the actual value of invalidated this property is undefined.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Unpacker.LastReadData">
|
|
<summary>
|
|
Gets a last unpacked data.
|
|
</summary>
|
|
<value>A last unpacked data. Initial value is <see cref="F:MsgPack.MessagePackObject.Nil"/>.</value>
|
|
<remarks>
|
|
If you use any of direct APIs (methods which return non-<see cref="T:MsgPack.MessagePackObject"/>),
|
|
then this property to be invalidated.
|
|
Note that the actual value of invalidated this property is undefined.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Unpacker.IsArrayHeader">
|
|
<summary>
|
|
Gets a value indicating whether this instance is positioned to array header.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instance is positioned to array header; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Unpacker.IsMapHeader">
|
|
<summary>
|
|
Gets a value indicating whether this instance is positioned to map header.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instance is positioned to map header; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Unpacker.IsCollectionHeader">
|
|
<summary>
|
|
Gets a value indicating whether this instance is positioned to array or map header.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instance is positioned to array or map header; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Unpacker.ItemsCount">
|
|
<summary>
|
|
Gets the items count for current array or map.
|
|
</summary>
|
|
<value>
|
|
The items count for current array or map.
|
|
</value>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
Both of the <see cref="P:MsgPack.Unpacker.IsArrayHeader"/> and <see cref="P:MsgPack.Unpacker.IsMapHeader"/> are <c>false</c>.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.Unpacker.UnderlyingStream">
|
|
<summary>
|
|
Gets the underlying stream to handle direct API.
|
|
</summary>
|
|
<exception cref="T:System.NotSupportedException">
|
|
This instance does not supoort direct API.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.ItemsUnpacker.ReadSubtreeCore">
|
|
<summary>
|
|
Starts unpacking of current subtree.
|
|
</summary>
|
|
<returns>
|
|
<see cref="T:MsgPack.Unpacker"/> to unpack current subtree.
|
|
This will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.ItemsUnpacker.ReadSubtreeItem">
|
|
<summary>
|
|
Read subtree item from current stream.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c>, if position is sucessfully move to next entry;
|
|
<c>false</c>, if position reaches the tail of the Message Pack stream.
|
|
</returns>
|
|
<remarks>
|
|
This method only be called from <see cref="T:MsgPack.SubtreeUnpacker"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.IUnpackable">
|
|
<summary>
|
|
Defines interface for object which can be deserialzed from MessagePack object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.IUnpackable.UnpackFromMessage(MsgPack.Unpacker)">
|
|
<summary>
|
|
Restore object state from specified <see cref="T:MsgPack.Unpacker"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/>.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="unpacker"/> is <c>null</c>.</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">Cannot restore state from the stream.</exception>
|
|
</member>
|
|
<member name="T:MsgPack.MessageNotSupportedException">
|
|
<summary>
|
|
Exception occurs when serialized stream contains structures or features which will never be supported by MsgPack/CLI implementation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessageNotSupportedException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessageNotSupportedException"/> class with the default error message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessageNotSupportedException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessageNotSupportedException"/> class with a specified error message.
|
|
</summary>
|
|
<param name="message">The message that describes the error. </param>
|
|
</member>
|
|
<member name="M:MsgPack.MessageNotSupportedException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessageNotSupportedException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception. </param>
|
|
<param name="inner">
|
|
The exception that is the cause of the current exception, or a <c>null</c> if no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackConvert">
|
|
<summary>
|
|
Define common convert rountines specific to MessagePack.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackConvert.EncodeString(System.String)">
|
|
<summary>
|
|
Encode specified string by default encoding.
|
|
</summary>
|
|
<param name="value">String value.</param>
|
|
<returns>Encoded <paramref name="value"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="value"/> is null.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackConvert.DecodeStringStrict(System.Byte[])">
|
|
<summary>
|
|
Decode specified byte[] by default encoding.
|
|
</summary>
|
|
<param name="value">Byte[] value.</param>
|
|
<returns>Decoded <paramref name="value"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="value"/> is null.
|
|
</exception>
|
|
<exception cref="T:System.Text.DecoderFallbackException">
|
|
<paramref name="value"/> contains non-UTF-8 bits.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackConvert.ToDateTimeOffset(System.Int64)">
|
|
<summary>
|
|
Convert specified <see cref="T:System.Int64"/> to <see cref="T:System.DateTimeOffset"/>.
|
|
</summary>
|
|
<param name="value">
|
|
<see cref="T:System.Int64"/> value which is unpacked from packed message and may represent date-time value.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:System.DateTimeOffset"/>. Offset of this value always 0.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackConvert.ToDateTime(System.Int64)">
|
|
<summary>
|
|
Convert specified <see cref="T:System.Int64"/> to <see cref="T:System.DateTime"/>.
|
|
</summary>
|
|
<param name="value">
|
|
<see cref="T:System.Int64"/> value which is unpacked from packed message and may represent date-time value.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:System.DateTime"/>. This value is always UTC.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackConvert.FromDateTimeOffset(System.DateTimeOffset)">
|
|
<summary>
|
|
Convert specified <see cref="T:System.DateTimeOffset"/> to <see cref="T:System.Int64"/> as MessagePack defacto-standard.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.DateTimeOffset"/>.</param>
|
|
<returns>
|
|
UTC epoc time from 1970/1/1 0:00:00, in milliseconds.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackConvert.FromDateTime(System.DateTime)">
|
|
<summary>
|
|
Convert specified <see cref="T:System.DateTime"/> to <see cref="T:System.Int64"/> as MessagePack defacto-standard.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.DateTime"/>.</param>
|
|
<returns>
|
|
UTC epoc time from 1970/1/1 0:00:00, in milliseconds.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackExtendedTypeObject">
|
|
<summary>
|
|
Represents Message Pack extended type object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.MessagePackExtendedTypeObject._typeCode">
|
|
<summary>
|
|
A type code of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.MessagePackExtendedTypeObject._body">
|
|
<summary>
|
|
A binary value portion of this object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.GetBody">
|
|
<summary>
|
|
Gets a copy of the binary value portion of this object.
|
|
</summary>
|
|
<value>
|
|
A copy of the binary value portion of this object. This value will not be null.
|
|
</value>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.#ctor(System.Byte,System.Byte[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> struct.
|
|
</summary>
|
|
<param name="typeCode">A type code of this extension object.</param>
|
|
<param name="body">A binary value portion.</param>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <paramref name="typeCode"/> is over 127. Higher values are reserved for MessagePack format specification.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="body"/> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.Unpack(System.Byte,System.Byte[])">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> struct.
|
|
</summary>
|
|
<param name="typeCode">A type code of this extension object.</param>
|
|
<param name="body">A binary value portion.</param>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="body"/> is <c>null</c>.</exception>
|
|
<remarks>
|
|
This method allows reserved type code. It means that this method does not throw exception when the <paramref name="typeCode"/> is reserved value (greater then 0x7F).
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.ToString">
|
|
<summary>
|
|
Returns a <see cref="T:System.String"/> that represents this instance.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.String"/> that represents this instance.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.GetHashCode">
|
|
<summary>
|
|
Returns a hash code for this instance.
|
|
</summary>
|
|
<returns>
|
|
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.Equals(System.Object)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
|
|
</summary>
|
|
<param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param>
|
|
<returns>
|
|
<c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.Equals(MsgPack.MessagePackExtendedTypeObject)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> is equal to this instance.
|
|
</summary>
|
|
<param name="other">The <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> to compare with this instance.</param>
|
|
<returns>
|
|
<c>true</c> if the specified <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> is equal to this instance; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.op_Equality(MsgPack.MessagePackExtendedTypeObject,MsgPack.MessagePackExtendedTypeObject)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>s are equal.
|
|
</summary>
|
|
<param name="left">A <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>.</param>
|
|
<param name="right">A <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>.</param>
|
|
<returns>
|
|
<c>true</c> if the specified <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>s are equal; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackExtendedTypeObject.op_Inequality(MsgPack.MessagePackExtendedTypeObject,MsgPack.MessagePackExtendedTypeObject)">
|
|
<summary>
|
|
Determines whether the specified <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>s are not equal.
|
|
</summary>
|
|
<param name="left">A <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>.</param>
|
|
<param name="right">A <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>.</param>
|
|
<returns>
|
|
<c>true</c> if the specified <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>s are not equal; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackExtendedTypeObject.TypeCode">
|
|
<summary>
|
|
Gets a type code of this object.
|
|
</summary>
|
|
<value>
|
|
A type code. Note that values over <see cref="F:System.SByte.MaxValue"/> are reserved for MsgPack spec itself.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackExtendedTypeObject.Body">
|
|
<summary>
|
|
Gets a binary value portion of this object.
|
|
</summary>
|
|
<value>
|
|
A binary value portion of this object. This value will not be null.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackExtendedTypeObject.IsValid">
|
|
<summary>
|
|
Gets a value indicating whether this instance is valid.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instance is valid; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObject">
|
|
<summary>
|
|
Represents deserialized object of MsgPack.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.Boolean"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Byte)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.Byte"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.SByte)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.SByte"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Int16)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.Int16"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.UInt16)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.UInt16"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.Int32"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.UInt32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.UInt32"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Int64)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.Int64"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.UInt64)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.UInt64"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Single)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.Single"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Double)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.Double"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:System.String"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Byte[])">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Byte"/>[] type which wraps <see cref="T:System.Byte"/>[] instance with specified manner.
|
|
</summary>
|
|
<param name="value">A bytes array to be wrapped.</param>
|
|
<remarks>
|
|
This constructor invokes <see cref="M:MsgPack.MessagePackObject.#ctor(System.Byte[],System.Boolean)"/> with <c>false</c>, that means if you pass tha bytes array which is valid utf-8, resulting object can be <see cref="T:System.String"/>,
|
|
and its <see cref="P:MsgPack.MessagePackObject.UnderlyingType"/> should be <see cref="T:System.String"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Byte[],System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Byte"/>[] type which wraps <see cref="T:System.Byte"/>[] instance with specified manner.
|
|
</summary>
|
|
<param name="value">A bytes array to be wrapped.</param>
|
|
<param name="isBinary"><c>true</c> if <paramref name="value"/> always should be binary; <c>false</c>, otherwise.</param>
|
|
<remarks>
|
|
When the <paramref name="isBinary"/> is <c>true</c>, then resulting object represents binary even if the <paramref name="value"/> is valid utf-8 sequence,
|
|
that is, its <see cref="P:MsgPack.MessagePackObject.UnderlyingType"/> should be <see cref="T:System.Byte"/>[].
|
|
On the other hand, when contrast, the <paramref name="isBinary"/> is <c>false</c>, and if the <paramref name="value"/> is valid utf-8,
|
|
then the resulting object can be <see cref="T:System.String"/>,
|
|
and its <see cref="P:MsgPack.MessagePackObject.UnderlyingType"/> should be <see cref="T:System.String"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(MsgPack.MessagePackExtendedTypeObject)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObject"/> type which wraps <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> instance.
|
|
</summary>
|
|
<param name="value">A <see cref="T:MsgPack.MessagePackObject"/> value to be wrapped.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsBoolean">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Boolean"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Boolean"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsByte">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Byte"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Byte"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsSByte">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.SByte"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.SByte"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsInt16">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Int16"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Int16"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsUInt16">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.UInt16"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.UInt16"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsInt32">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Int32"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Int32"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsUInt32">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.UInt32"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.UInt32"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsInt64">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Int64"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Int64"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsUInt64">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.UInt64"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.UInt64"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsSingle">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Single"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Single"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsDouble">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Double"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Double"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsString">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.String"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:System.String"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsBinary">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Byte"/>[] instance.
|
|
</summary>
|
|
<returns><see cref="T:System.Byte"/>[] instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsMessagePackExtendedTypeObject">
|
|
<summary>
|
|
Convert this instance to <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> instance.
|
|
</summary>
|
|
<returns><see cref="T:MsgPack.MessagePackExtendedTypeObject"/> instance corresponds to this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Boolean)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Boolean"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Boolean"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Byte)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Byte"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.SByte)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.SByte"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.SByte"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Int16)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Int16"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int16"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.UInt16)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.UInt16"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.UInt16"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Int32)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Int32"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int32"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.UInt32)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.UInt32"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.UInt32"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Int64)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Int64"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int64"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.UInt64)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.UInt64"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.UInt64"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Single)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Single"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Single"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Double)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Double"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Double"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.String)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.String"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.String"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(System.Byte[])~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:System.Byte"/>[]instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/>[] instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(MsgPack.MessagePackExtendedTypeObject)~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackExtendedTypeObject"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Boolean">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Boolean"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Boolean"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Byte">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Byte"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Byte"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.SByte">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.SByte"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.SByte"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Int16">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Int16"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Int16"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.UInt16">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.UInt16"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.UInt16"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Int32">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Int32"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Int32"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.UInt32">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.UInt32"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.UInt32"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Int64">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Int64"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Int64"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.UInt64">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.UInt64"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.UInt64"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Single">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Single"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Single"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Double">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Double"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Double"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.String">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.String"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.String"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~System.Byte[]">
|
|
<summary>
|
|
Convert this instance to <see cref="T:System.Byte"/>[] instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:System.Byte"/>[] instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Explicit(MsgPack.MessagePackObject)~MsgPack.MessagePackExtendedTypeObject">
|
|
<summary>
|
|
Convert this instance to <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackExtendedTypeObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="F:MsgPack.MessagePackObject.Nil">
|
|
<summary>
|
|
Instance represents nil. This is equal to default value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Collections.Generic.IList{MsgPack.MessagePackObject})">
|
|
<summary>
|
|
Initializes a new instance wraps <see cref="T:System.Collections.Generic.IList`1"/>.
|
|
</summary>
|
|
<param name="value">
|
|
The collection to be copied.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(System.Collections.Generic.IList{MsgPack.MessagePackObject},System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance wraps <see cref="T:System.Collections.Generic.IList`1"/>.
|
|
</summary>
|
|
<param name="value">
|
|
The collection to be copied or used.
|
|
</param>
|
|
<param name="isImmutable">
|
|
<c>true</c> if the <paramref name="value"/> is immutable collection;
|
|
othereise, <c>false</c>.
|
|
</param>
|
|
<remarks>
|
|
When the collection is truely immutable or dedicated, you can specify <c>true</c> to the <paramref name="isImmutable"/>.
|
|
When <paramref name="isImmutable"/> is <c>true</c>, this constructor does not copy its contents,
|
|
or copies its contents otherwise.
|
|
<note>
|
|
Note that both of IReadOnlyList and <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1"/> is NOT immutable
|
|
because the modification to the underlying collection will be reflected to the read-only collection.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(MsgPack.MessagePackObjectDictionary)">
|
|
<summary>
|
|
Initializes a new instance wraps <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<param name="value">
|
|
The dictitonary to be copied.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(MsgPack.MessagePackObjectDictionary,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance wraps <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<param name="value">
|
|
The dictitonary to be copied or used.
|
|
</param>
|
|
<param name="isImmutable">
|
|
<c>true</c> if the <paramref name="value"/> is immutable collection;
|
|
othereise, <c>false</c>.
|
|
</param>
|
|
<remarks>
|
|
When the collection is truely immutable or dedicated, you can specify <c>true</c> to the <paramref name="isImmutable"/>.
|
|
When <paramref name="isImmutable"/> is <c>true</c>, this constructor does not copy its contents,
|
|
or copies its contents otherwise.
|
|
<note>
|
|
Note that both of IReadOnlyDictionary and ReadOnlyDictionary is NOT immutable
|
|
because the modification to the underlying collection will be reflected to the read-only collection.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.#ctor(MsgPack.MessagePackString)">
|
|
<summary>
|
|
Initializes a new instance wraps <see cref="T:MsgPack.MessagePackString"/>.
|
|
</summary>
|
|
<param name="messagePackString"><see cref="T:MsgPack.MessagePackString"/> which represents byte array or UTF-8 encoded string.</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.Equals(System.Object)">
|
|
<summary>
|
|
Compare two instances are equal.
|
|
</summary>
|
|
<param name="obj"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns>
|
|
If <paramref name="obj"/> is <see cref="T:MsgPack.MessagePackObject"/> and its value is equal to this instance, then true.
|
|
Otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.Equals(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Compare two instances are equal.
|
|
</summary>
|
|
<param name="other"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns>
|
|
Whether value of <paramref name="other"/> is equal to this instance or not.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.GetHashCode">
|
|
<summary>
|
|
Get hash code of this instance.
|
|
</summary>
|
|
<returns>Hash code of this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.ToString">
|
|
<summary>
|
|
Returns a string that represents the current object.
|
|
</summary>
|
|
<returns>
|
|
A string that represents the current object.
|
|
</returns>
|
|
<remarks>
|
|
<note>
|
|
DO NOT use this value programmically.
|
|
The purpose of this method is informational, so format of this value subject to change.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.IsTypeOf``1">
|
|
<summary>
|
|
Determine whether the underlying value of this instance is specified type or not.
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<returns>If the underlying value of this instance is <typeparamref name="T"/> then true, otherwise false.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.IsTypeOf(System.Type)">
|
|
<summary>
|
|
Determine whether the underlying value of this instance is specified type or not.
|
|
</summary>
|
|
<param name="type">Target type.</param>
|
|
<returns>If the underlying value of this instance is <paramref name="type"/> then true, otherwise false.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="type"/> is null.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.PackToMessage(MsgPack.Packer,MsgPack.PackingOptions)">
|
|
<summary>
|
|
Pack this instance itself using specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
<param name="packer"><see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="options">Packing options. This value can be null.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="packer"/> is null.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsString(System.Text.Encoding)">
|
|
<summary>
|
|
Gets the underlying value as string encoded with specified <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
<returns>
|
|
The string.
|
|
Note that some <see cref="T:System.Text.Encoding"/> returns <c>null</c> if the binary is not valid encoded string.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsStringUtf8">
|
|
<summary>
|
|
Get underlying value as UTF8 string.
|
|
</summary>
|
|
<returns>Underlying raw binary.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsStringUtf16">
|
|
<summary>
|
|
Get underlying value as UTF-16 string.
|
|
</summary>
|
|
<returns>Underlying string.</returns>
|
|
<remarks>
|
|
This method detects BOM. If BOM is not exist, them bytes should be Big-Endian UTF-16.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsCharArray">
|
|
<summary>
|
|
Get underlying value as UTF-16 charcter array.
|
|
</summary>
|
|
<returns>Underlying string.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsEnumerable">
|
|
<summary>
|
|
Get underlying value as <see cref="T:System.Collections.Generic.IEnumerable`1"/>.
|
|
</summary>
|
|
<returns>Underlying <see cref="T:System.Collections.Generic.IEnumerable`1"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsList">
|
|
<summary>
|
|
Get underlying value as <see cref="T:System.Collections.Generic.IList`1"/>.
|
|
</summary>
|
|
<returns>Underlying <see cref="T:System.Collections.Generic.IList`1"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.AsDictionary">
|
|
<summary>
|
|
Get underlying value as <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<returns>Underlying <see cref="T:MsgPack.MessagePackObjectDictionary"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.FromObject(System.Object)">
|
|
<summary>
|
|
Wraps specified object as <see cref="T:MsgPack.MessagePackObject"/> recursively.
|
|
</summary>
|
|
<param name="boxedValue">Object to be wrapped.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> wrapps <paramref name="boxedValue"/>.</returns>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
<paramref name="boxedValue"/> is not primitive value type, list of <see cref="T:MsgPack.MessagePackObject"/>,
|
|
dictionary of <see cref="T:MsgPack.MessagePackObject"/>, <see cref="T:System.String"/>, <see cref="T:System.Byte"/>[], or null.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.ToObject">
|
|
<summary>
|
|
Get boxed underlying value for this object.
|
|
</summary>
|
|
<returns>Boxed underlying value for this object.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Equality(MsgPack.MessagePackObject,MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Compare two instances are equal.
|
|
</summary>
|
|
<param name="left"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<param name="right"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns>
|
|
Whether value of <paramref name="left"/> and <paramref name="right"/> are equal each other or not.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Inequality(MsgPack.MessagePackObject,MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Compare two instances are not equal.
|
|
</summary>
|
|
<param name="left"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<param name="right"><see cref="T:MsgPack.MessagePackObject"/> instance.</param>
|
|
<returns>
|
|
Whether value of <paramref name="left"/> and <paramref name="right"/> are not equal each other or are equal.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObject.op_Implicit(MsgPack.MessagePackObject[])~MsgPack.MessagePackObject">
|
|
<summary>
|
|
Convert <see cref="T:MsgPack.MessagePackObject"/>[] instance to <see cref="T:MsgPack.MessagePackObject"/> instance.
|
|
</summary>
|
|
<param name="value"><see cref="T:MsgPack.MessagePackObject"/>[] instance.</param>
|
|
<returns><see cref="T:MsgPack.MessagePackObject"/> instance corresponds to <paramref name="value"/>.</returns>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObject.IsNil">
|
|
<summary>
|
|
Get whether this instance represents nil.
|
|
</summary>
|
|
<value>If this instance represents nil object, then true.</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObject.IsRaw">
|
|
<summary>
|
|
Get the value indicates whether this instance wraps raw binary (or string) or not.
|
|
</summary>
|
|
<value>This instance wraps raw binary (or string) then true.</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObject.IsList">
|
|
<summary>
|
|
Get the value indicates whether this instance wraps list (array) or not.
|
|
</summary>
|
|
<value>This instance wraps list (array) then true.</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObject.IsArray">
|
|
<summary>
|
|
Get the value indicates whether this instance wraps list (array) or not.
|
|
</summary>
|
|
<value>This instance wraps list (array) then true.</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObject.IsDictionary">
|
|
<summary>
|
|
Get the value indicates whether this instance wraps dictionary (map) or not.
|
|
</summary>
|
|
<value>This instance wraps dictionary (map) then true.</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObject.IsMap">
|
|
<summary>
|
|
Get the value indicates whether this instance wraps dictionary (map) or not.
|
|
</summary>
|
|
<value>This instance wraps dictionary (map) then true.</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObject.UnderlyingType">
|
|
<summary>
|
|
Get underlying type of this instance.
|
|
</summary>
|
|
<returns>Underlying <see cref="T:System.Type"/>.</returns>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectDictionary">
|
|
<summary>
|
|
Implements <see cref="T:System.Collections.Generic.IDictionary`2"/> for <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<remarks>
|
|
This dictionary handles <see cref="T:MsgPack.MessagePackObject"/> type semantics for the key.
|
|
Additionally, this dictionary implements 'freezing' feature.
|
|
For details, see <see cref="P:MsgPack.MessagePackObjectDictionary.IsFrozen"/>, <see cref="M:MsgPack.MessagePackObjectDictionary.Freeze"/>, and <see cref="M:MsgPack.MessagePackObjectDictionary.AsFrozen"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.#ctor">
|
|
<summary>
|
|
Initializes an empty new instance of the <see cref="T:MsgPack.MessagePackObjectDictionary"/> class with default capacity.
|
|
</summary>
|
|
<remarks>
|
|
This operation is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes an empty new instance of the <see cref="T:MsgPack.MessagePackObjectDictionary"/> class with specified initial capacity.
|
|
</summary>
|
|
<param name="initialCapacity">The initial capacity.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="initialCapacity"/> is negative.
|
|
</exception>
|
|
<remarks>
|
|
This operation is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.#ctor(System.Collections.Generic.IDictionary{MsgPack.MessagePackObject,MsgPack.MessagePackObject})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObjectDictionary"/> class.
|
|
</summary>
|
|
<param name="dictionary">The dictionary to be copied from.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="dictionary"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
Failed to copy from <paramref name="dictionary"/>.
|
|
</exception>
|
|
<remarks>
|
|
This constructor takes <em>O(N)</em> time, <em>N</em> is <see cref="P:ICollection{T}.Count"/> of <paramref name="dictionary"/>.
|
|
Initial capacity will be <see cref="P:ICollection{T}.Count"/> of <paramref name="dictionary"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ContainsKey(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Determines whether the <see cref="T:MsgPack.MessagePackObjectDictionary"/> contains an element with the specified key.
|
|
</summary>
|
|
<param name="key">The key to locate in the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key"/> is <see cref="F:MsgPack.MessagePackObject.Nil"/>.
|
|
</exception>
|
|
<returns>
|
|
<c>true</c> if the <see cref="T:MsgPack.MessagePackObjectDictionary"/> contains an element with the key; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This method approaches an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ContainsValue(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Determines whether the <see cref="T:MsgPack.MessagePackObjectDictionary"/> contains an element with the specified value.
|
|
</summary>
|
|
<param name="value">The value to locate in the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.</param>
|
|
<returns>
|
|
<c>true</c> if the <see cref="T:MsgPack.MessagePackObjectDictionary"/> contains an element with the value; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This method approaches an O(<em>N</em>) operation where <em>N</em> is <see cref="P:MsgPack.MessagePackObjectDictionary.Count"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.TryGetValue(MsgPack.MessagePackObject,MsgPack.MessagePackObject@)">
|
|
<summary>
|
|
Gets the value associated with the specified key.
|
|
</summary>
|
|
<param name="key">
|
|
The key whose value to get.
|
|
</param>
|
|
<param name="value">
|
|
When this method returns, the value associated with the specified key, if the key is found;
|
|
otherwise, the default value for the type of the <paramref name="value"/> parameter.
|
|
This parameter is passed uninitialized.
|
|
</param>
|
|
<returns>
|
|
<c>true</c> if this dictionary contains an element with the specified key; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key"/> is <see cref="F:MsgPack.MessagePackObject.Nil"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Note that tiny integers are considered equal regardless of its CLI <see cref="T:System.Type"/>,
|
|
and UTF-8 encoded bytes are considered equals to <see cref="T:System.String"/>.
|
|
</para>
|
|
<para>
|
|
This method approaches an O(1) operation.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.Add(MsgPack.MessagePackObject,MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Adds the specified key and value to the dictionary.
|
|
</summary>
|
|
<param name="key">
|
|
The key of the element to add.
|
|
</param>
|
|
<param name="value">
|
|
The value of the element to add. The value can be <c>null</c> for reference types.
|
|
</param>
|
|
<returns>
|
|
An element with the same key already does not exist in the dictionary and sucess to add then newly added node;
|
|
otherwise <c>null</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="key"/> already exists in this dictionary.
|
|
Note that tiny integers are considered equal regardless of its CLI <see cref="T:System.Type"/>,
|
|
and UTF-8 encoded bytes are considered equals to <see cref="T:System.String"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key"/> is <see cref="F:MsgPack.MessagePackObject.Nil"/>.
|
|
</exception>
|
|
<remarks>
|
|
If <see cref="P:MsgPack.MessagePackObjectDictionary.Count"/> is less than the capacity, this method approaches an O(1) operation.
|
|
If the capacity must be increased to accommodate the new element,
|
|
this method becomes an O(<em>N</em>) operation, where <em>N</em> is <see cref="P:MsgPack.MessagePackObjectDictionary.Count"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.Remove(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Removes the element with the specified key from the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<param name="key">The key of the element to remove.</param>
|
|
<returns>
|
|
<c>true</c> if the element is successfully removed; otherwise, <c>false</c>.
|
|
This method also returns false if <paramref name="key"/> was not found in the original <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key"/> is <see cref="F:MsgPack.MessagePackObject.Nil"/>.
|
|
</exception>
|
|
<remarks>
|
|
This method approaches an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.Clear">
|
|
<summary>
|
|
Removes all items from the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<remarks>
|
|
This method approaches an O(<em>N</em>) operation, where <em>N</em> is <see cref="P:MsgPack.MessagePackObjectDictionary.Count"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<returns>
|
|
Returns an enumerator that iterates through the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</returns>
|
|
<remarks>
|
|
This method is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.Freeze">
|
|
<summary>
|
|
Freezes this instance.
|
|
</summary>
|
|
<returns>
|
|
This instance itself.
|
|
This value will not be <c>null</c> and its <see cref="P:MsgPack.MessagePackObjectDictionary.IsFrozen"/> is <c>true</c>.
|
|
</returns>
|
|
<remarks>
|
|
This method freezes this instance itself.
|
|
This operation is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.AsFrozen">
|
|
<summary>
|
|
Gets a copy of this instance as frozen instance.
|
|
</summary>
|
|
<returns>
|
|
New <see cref="T:MsgPack.MessagePackObjectDictionary"/> instance which contains same items as this instance.
|
|
This value will not be <c>null</c> and its <see cref="P:MsgPack.MessagePackObjectDictionary.IsFrozen"/> is <c>true</c>.
|
|
</returns>
|
|
<remarks>
|
|
This method does not freeze this instance itself.
|
|
This operation is an O(<em>N</em>) operation where <em>O(N)</em> <see cref="P:MsgPack.MessagePackObjectDictionary.Count"/> of items.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.IsFrozen">
|
|
<summary>
|
|
Gets a value indicating whether this instance is frozen.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instance is frozen; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
This operation is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<returns>
|
|
The number of elements contained in the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</returns>
|
|
<remarks>
|
|
This operation is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.Item(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Gets or sets the element with the specified key.
|
|
</summary>
|
|
<value>
|
|
The element with the specified key.
|
|
</value>
|
|
<param name="key">Key for geting or seting value.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key"/> is <see cref="F:MsgPack.MessagePackObject.Nil"/>.
|
|
</exception>
|
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">
|
|
The property is retrieved and <paramref name="key"/> is not found.
|
|
</exception>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The property is set and this instance is frozen.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Note that tiny integers are considered equal regardless of its CLI <see cref="T:System.Type"/>,
|
|
and UTF-8 encoded bytes are considered equals to <see cref="T:System.String"/>.
|
|
</para>
|
|
<para>
|
|
This method approaches an O(1) operation.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.Keys">
|
|
<summary>
|
|
Gets an <see cref="T:MsgPack.MessagePackObjectDictionary.KeyCollection"/> containing the keys of the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:MsgPack.MessagePackObjectDictionary.KeyCollection"/> containing the keys of the object.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
<remarks>
|
|
This operation is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.Values">
|
|
<summary>
|
|
Gets an <see cref="T:MsgPack.MessagePackObjectDictionary.ValueCollection"/> containing the values of the <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:MsgPack.MessagePackObjectDictionary.ValueCollection"/> containing the values of the object.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
<remarks>
|
|
This operation is an O(1) operation.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectDictionary.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:MsgPack.MessagePackObjectDictionary"/> in order.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.Enumerator.Dispose">
|
|
<summary>
|
|
Releases all resources used by the this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the underlying collection.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the enumerator was successfully advanced to the next element;
|
|
<c>false</c> if the enumerator has passed the end of the collection.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.Enumerator.System#Collections#IEnumerator#Reset">
|
|
<summary>
|
|
Sets the enumerator to its initial position, which is before the first element in the collection.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.Enumerator.Current">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<value>
|
|
The element in the underlying collection at the current position of the enumerator.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.Enumerator.System#Collections#IEnumerator#Current">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<value>
|
|
The element in the collection at the current position of the enumerator, as an <see cref="T:System.Object"/>.
|
|
</value>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The enumerator is positioned before the first element of the collection or after the last element.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectDictionary.DictionaryEnumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:MsgPack.MessagePackObjectDictionary"/> in order.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.DictionaryEnumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the underlying collection.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the enumerator was successfully advanced to the next element;
|
|
<c>false</c> if the enumerator has passed the end of the collection.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.DictionaryEnumerator.System#Collections#IEnumerator#Reset">
|
|
<summary>
|
|
Sets the enumerator to its initial position, which is before the first element in the collection.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.DictionaryEnumerator.Current">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<value>
|
|
The element in the collection at the current position of the enumerator, as an <see cref="T:System.Object"/>.
|
|
</value>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The enumerator is positioned before the first element of the collection or after the last element.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.DictionaryEnumerator.Entry">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<returns>
|
|
The element in the dictionary at the current position of the enumerator, as a <see cref="T:System.Collections.DictionaryEntry"/>.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The enumerator is positioned before the first element of the collection or after the last element.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.DictionaryEnumerator.Key">
|
|
<summary>
|
|
Gets the key of the element at the current position of the enumerator.
|
|
</summary>
|
|
<returns>
|
|
The key of the element in the dictionary at the current position of the enumerator.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The enumerator is positioned before the first element of the collection or after the last element.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.DictionaryEnumerator.Value">
|
|
<summary>
|
|
Gets the value of the element at the current position of the enumerator.
|
|
</summary>
|
|
<returns>
|
|
The value of the element in the dictionary at the current position of the enumerator.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The enumerator is positioned before the first element of the collection or after the last element.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectDictionary.KeyCollection">
|
|
<summary>
|
|
Represents the set of <see cref="T:MsgPack.MessagePackObjectDictionary"/> keys.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.CopyTo(MsgPack.MessagePackObject[])">
|
|
<summary>
|
|
Copies the entire collection to a compatible one-dimensional array, starting at the beginning of the target array.
|
|
</summary>
|
|
<param name="array">
|
|
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from this dictionary.
|
|
The <see cref="T:System.Array"/> must have zero-based indexing.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.CopyTo(MsgPack.MessagePackObject[],System.Int32)">
|
|
<summary>
|
|
Copies the entire collection to a compatible one-dimensional array,
|
|
starting at the specified index of the target array.
|
|
</summary>
|
|
<param name="array">
|
|
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from this dictionary.
|
|
The <see cref="T:System.Array"/> must have zero-based indexing.
|
|
</param>
|
|
<param name="arrayIndex">
|
|
The zero-based index in <paramref name="array"/> at which copying begins.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.CopyTo(System.Int32,MsgPack.MessagePackObject[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Copies a range of elements from this collection to a compatible one-dimensional array,
|
|
starting at the specified index of the target array.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index in the source dictionary at which copying begins.
|
|
</param>
|
|
<param name="array">
|
|
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from this dictionary.
|
|
The <see cref="T:System.Array"/> must have zero-based indexing.
|
|
</param>
|
|
<param name="arrayIndex">
|
|
The zero-based index in <paramref name="array"/> at which copying begins.
|
|
</param>
|
|
<param name="count">
|
|
The number of elements to copy.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.System#Collections#Generic#ICollection{MsgPack#MessagePackObject}#Contains(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Determines whether this collection contains a specific value.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in this collection.</param>
|
|
<returns>
|
|
<c>true</c> if <paramref name="item"/> is found in this collection; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through this collction.
|
|
</summary>
|
|
<returns>
|
|
Returns an enumerator that iterates through this collction.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.KeyCollection.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
|
|
</summary>
|
|
<returns>
|
|
The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectDictionary.KeyCollection.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:MsgPack.MessagePackObjectDictionary.KeyCollection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.Enumerator.Dispose">
|
|
<summary>
|
|
Releases all resources used by the this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the underlying collection.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the enumerator was successfully advanced to the next element;
|
|
<c>false</c> if the enumerator has passed the end of the collection.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.KeyCollection.Enumerator.System#Collections#IEnumerator#Reset">
|
|
<summary>
|
|
Sets the enumerator to its initial position, which is before the first element in the collection.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.KeyCollection.Enumerator.Current">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<value>
|
|
The element in the underlying collection at the current position of the enumerator.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.KeyCollection.Enumerator.System#Collections#IEnumerator#Current">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<value>
|
|
The element in the collection at the current position of the enumerator, as an <see cref="T:System.Object"/>.
|
|
</value>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The enumerator is positioned before the first element of the collection or after the last element.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectDictionary.ValueCollection">
|
|
<summary>
|
|
Represents the collection of values in a <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.CopyTo(MsgPack.MessagePackObject[])">
|
|
<summary>
|
|
Copies the entire collection to a compatible one-dimensional array, starting at the beginning of the target array.
|
|
</summary>
|
|
<param name="array">
|
|
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from this dictionary.
|
|
The <see cref="T:System.Array"/> must have zero-based indexing.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.CopyTo(MsgPack.MessagePackObject[],System.Int32)">
|
|
<summary>
|
|
Copies the entire collection to a compatible one-dimensional array,
|
|
starting at the specified index of the target array.
|
|
</summary>
|
|
<param name="array">
|
|
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from this dictionary.
|
|
The <see cref="T:System.Array"/> must have zero-based indexing.
|
|
</param>
|
|
<param name="arrayIndex">
|
|
The zero-based index in <paramref name="array"/> at which copying begins.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.CopyTo(System.Int32,MsgPack.MessagePackObject[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Copies a range of elements from this collection to a compatible one-dimensional array,
|
|
starting at the specified index of the target array.
|
|
</summary>
|
|
<param name="index">
|
|
The zero-based index in the source dictionary at which copying begins.
|
|
</param>
|
|
<param name="array">
|
|
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from this dictionary.
|
|
The <see cref="T:System.Array"/> must have zero-based indexing.
|
|
</param>
|
|
<param name="arrayIndex">
|
|
The zero-based index in <paramref name="array"/> at which copying begins.
|
|
</param>
|
|
<param name="count">
|
|
The number of elements to copy.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.System#Collections#Generic#ICollection{MsgPack#MessagePackObject}#Contains(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Determines whether this collection contains a specific value.
|
|
</summary>
|
|
<param name="item">
|
|
The object to locate in this collection.</param>
|
|
<returns>
|
|
<c>true</c> if <paramref name="item"/> is found in this collection; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through this collction.
|
|
</summary>
|
|
<returns>
|
|
Returns an enumerator that iterates through this collction.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.ValueCollection.Count">
|
|
<summary>
|
|
Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
|
|
</summary>
|
|
<returns>
|
|
The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectDictionary.ValueCollection.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:MsgPack.MessagePackObjectDictionary.ValueCollection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.Enumerator.Dispose">
|
|
<summary>
|
|
Releases all resources used by the this instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the underlying collection.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the enumerator was successfully advanced to the next element;
|
|
<c>false</c> if the enumerator has passed the end of the collection.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectDictionary.ValueCollection.Enumerator.System#Collections#IEnumerator#Reset">
|
|
<summary>
|
|
Sets the enumerator to its initial position, which is before the first element in the collection.
|
|
</summary>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The collection was modified after the enumerator was created.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.ValueCollection.Enumerator.Current">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<value>
|
|
The element in the underlying collection at the current position of the enumerator.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.MessagePackObjectDictionary.ValueCollection.Enumerator.System#Collections#IEnumerator#Current">
|
|
<summary>
|
|
Gets the element at the current position of the enumerator.
|
|
</summary>
|
|
<value>
|
|
The element in the collection at the current position of the enumerator, as an <see cref="T:System.Object"/>.
|
|
</value>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
The enumerator is positioned before the first element of the collection or after the last element.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackObjectEqualityComparer">
|
|
<summary>
|
|
Implements <see cref="T:System.Collections.Generic.EqualityComparer`1"/> of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectEqualityComparer.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessagePackObjectEqualityComparer"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectEqualityComparer.Equals(MsgPack.MessagePackObject,MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Determines whether two objects of type <see cref="T:MsgPack.MessagePackObject"/> are equal.
|
|
</summary>
|
|
<param name="x">The first object to compare.</param>
|
|
<param name="y">The second object to compare.</param>
|
|
<returns>
|
|
<c>true</c> if the specified objects are equal; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.MessagePackObjectEqualityComparer.GetHashCode(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Returns a hash code for the specified <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<param name="obj">The <see cref="T:MsgPack.MessagePackObject"/>.</param>
|
|
<returns>
|
|
A hash code for <paramref name="obj"/>, suitable for use in hashing algorithms and data structures like a hash table.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.MessagePackString">
|
|
<summary>
|
|
Encapselates <see cref="T:System.String"/> and its serialized UTF-8 bytes.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.MessageTypeException">
|
|
<summary>
|
|
Represents unpacking error when message type is unknown or unavailable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessageTypeException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessageTypeException"/> class with the default error message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.MessageTypeException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessageTypeException"/> class with a specified error message.
|
|
</summary>
|
|
<param name="message">The message that describes the error. </param>
|
|
</member>
|
|
<member name="M:MsgPack.MessageTypeException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.MessageTypeException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception. </param>
|
|
<param name="inner">
|
|
The exception that is the cause of the current exception, or a <c>null</c> if no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="T:MsgPack.Packer">
|
|
<summary>
|
|
Implements serialization feature of MsgPack.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Packer"/> class with <see cref="P:MsgPack.Packer.DefaultCompatibilityOptions"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.#ctor(MsgPack.PackerCompatibilityOptions)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Packer"/> class with specified <see cref="T:MsgPack.PackerCompatibilityOptions"/>.
|
|
</summary>
|
|
<param name="compatibilityOptions">A <see cref="T:MsgPack.PackerCompatibilityOptions"/> which specifies compatibility options.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Create(System.IO.Stream)">
|
|
<summary>
|
|
Create standard Safe <see cref="T:MsgPack.Packer"/> instancde wrapping specified <see cref="T:System.IO.Stream"/> with <see cref="P:MsgPack.Packer.DefaultCompatibilityOptions"/>.
|
|
</summary>
|
|
<param name="stream"><see cref="T:System.IO.Stream"/> object. This stream will be closed when <see cref="M:MsgPack.Packer.Dispose(System.Boolean)"/> is called.</param>
|
|
<returns>Safe <see cref="T:MsgPack.Packer"/>. This will not be null.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
<remarks>
|
|
You can specify any derived <see cref="T:System.IO.Stream"/> class like FileStream, <see cref="T:System.IO.MemoryStream"/>,
|
|
NetworkStream, UnmanagedMemoryStream, or so.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Create(System.IO.Stream,MsgPack.PackerCompatibilityOptions)">
|
|
<summary>
|
|
Create standard Safe <see cref="T:MsgPack.Packer"/> instancde wrapping specified <see cref="T:System.IO.Stream"/> with specified <see cref="T:MsgPack.PackerCompatibilityOptions"/>.
|
|
</summary>
|
|
<param name="stream"><see cref="T:System.IO.Stream"/> object. This stream will be closed when <see cref="M:MsgPack.Packer.Dispose(System.Boolean)"/> is called.</param>
|
|
<param name="compatibilityOptions">A <see cref="T:MsgPack.PackerCompatibilityOptions"/> which specifies compatibility options.</param>
|
|
<returns>Safe <see cref="T:MsgPack.Packer"/>. This will not be null.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
<remarks>
|
|
You can specify any derived <see cref="T:System.IO.Stream"/> class like FileStream, <see cref="T:System.IO.MemoryStream"/>,
|
|
NetworkStream, UnmanagedMemoryStream, or so.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Create(System.IO.Stream,System.Boolean)">
|
|
<summary>
|
|
Create standard Safe <see cref="T:MsgPack.Packer"/> instancde wrapping specified <see cref="T:System.IO.Stream"/> with <see cref="P:MsgPack.Packer.DefaultCompatibilityOptions"/>.
|
|
</summary>
|
|
<param name="stream"><see cref="T:System.IO.Stream"/> object.</param>
|
|
<param name="ownsStream">
|
|
<c>true</c> to close <paramref name="stream"/> when this instance is disposed;
|
|
<c>false</c>, otherwise.
|
|
</param>
|
|
<returns>Safe <see cref="T:MsgPack.Packer"/>. This will not be null.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
<remarks>
|
|
You can specify any derived <see cref="T:System.IO.Stream"/> class like FileStream, <see cref="T:System.IO.MemoryStream"/>,
|
|
NetworkStream, UnmanagedMemoryStream, or so.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Create(System.IO.Stream,MsgPack.PackerCompatibilityOptions,System.Boolean)">
|
|
<summary>
|
|
Create standard Safe <see cref="T:MsgPack.Packer"/> instancde wrapping specified <see cref="T:System.IO.Stream"/> with specified <see cref="T:MsgPack.PackerCompatibilityOptions"/>.
|
|
</summary>
|
|
<param name="stream"><see cref="T:System.IO.Stream"/> object.</param>
|
|
<param name="compatibilityOptions">A <see cref="T:MsgPack.PackerCompatibilityOptions"/> which specifies compatibility options.</param>
|
|
<param name="ownsStream">
|
|
<c>true</c> to close <paramref name="stream"/> when this instance is disposed;
|
|
<c>false</c>, otherwise.
|
|
</param>
|
|
<returns>Safe <see cref="T:MsgPack.Packer"/>. This will not be null.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
|
|
<remarks>
|
|
You can specify any derived <see cref="T:System.IO.Stream"/> class like FileStream, <see cref="T:System.IO.MemoryStream"/>,
|
|
NetworkStream, UnmanagedMemoryStream, or so.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Dispose">
|
|
<summary>
|
|
Clean up internal resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Dispose(System.Boolean)">
|
|
<summary>
|
|
When overridden by derived class, release all unmanaged resources, optionally release managed resources.
|
|
</summary>
|
|
<param name="disposing">If true, release managed resources too.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.SeekTo(System.Int64)">
|
|
<summary>
|
|
When overridden by derived class, change current position to specified offset.
|
|
</summary>
|
|
<param name="offset">Offset. You shoud not specify the value which causes underflow or overflow.</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
A class of this instance does not support seek.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.WriteByte(System.Byte)">
|
|
<summary>
|
|
When overridden by derived class, writes specified byte to stream using implementation specific manner.
|
|
</summary>
|
|
<param name="value">A byte to be written.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.WriteBytes(System.Collections.Generic.ICollection{System.Byte})">
|
|
<summary>
|
|
Writes specified bytes to stream using implementation specific most efficient manner.
|
|
</summary>
|
|
<param name="value">Collection of bytes to be written.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.WriteBytes(System.Byte[],System.Boolean)">
|
|
<summary>
|
|
Writes specified bytes to stream using implementation specific most efficient manner.
|
|
</summary>
|
|
<param name="value">Bytes to be written.</param>
|
|
<param name="isImmutable">If the <paramref name="value"/> can be treat as immutable (that is, can be used safely without copying) then <c>true</c>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.SByte)">
|
|
<summary>
|
|
Packs <see cref="T:System.SByte"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.SByte"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackInt8(System.Int64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.SByte"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.SByte"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Byte)">
|
|
<summary>
|
|
Packs <see cref="T:System.Byte"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackUInt8(System.UInt64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.Byte"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.Byte"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Int16)">
|
|
<summary>
|
|
Packs <see cref="T:System.Int16"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int16"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackInt16(System.Int64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.Int16"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.Int16"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.UInt16)">
|
|
<summary>
|
|
Packs <see cref="T:System.UInt16"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.UInt16"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackUInt16(System.UInt64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.UInt16"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.UInt16"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Int32)">
|
|
<summary>
|
|
Packs <see cref="T:System.Int32"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int32"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackInt32(System.Int64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.Int32"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.Int32"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.UInt32)">
|
|
<summary>
|
|
Packs <see cref="T:System.UInt32"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.UInt32"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackUInt32(System.UInt64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.UInt32"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.UInt32"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Int64)">
|
|
<summary>
|
|
Packs <see cref="T:System.Int64"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int64"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackInt64(System.Int64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.Int64"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.Int64"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.UInt64)">
|
|
<summary>
|
|
Packs <see cref="T:System.UInt64"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.UInt64"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackUInt64(System.UInt64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.UInt64"/> value to current stream strictly.
|
|
</summary>
|
|
<param name="value">Maybe <see cref="T:System.UInt64"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Single)">
|
|
<summary>
|
|
Packs <see cref="T:System.Single"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Single"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Double)">
|
|
<summary>
|
|
Packs <see cref="T:System.Double"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Double"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Boolean)">
|
|
<summary>
|
|
Packs <see cref="T:System.Boolean"/> value to current stream.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Boolean"/> value.</param>
|
|
<returns>This instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackArrayHeader(System.Int32)">
|
|
<summary>
|
|
Bookkeep array length to be packed on current stream.
|
|
</summary>
|
|
<param name="count">Array length.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackArrayHeaderCore(System.Int32)">
|
|
<summary>
|
|
Bookkeep array length to be packed on current stream.
|
|
</summary>
|
|
<param name="count">Array length.</param>
|
|
<returns>This instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackMapHeader(System.Int32)">
|
|
<summary>
|
|
Bookkeep dictionary items count to be packed on current stream.
|
|
</summary>
|
|
<param name="count">Dictionary items count.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackMapHeaderCore(System.Int32)">
|
|
<summary>
|
|
Bookkeep dictionary items count to be packed on current stream.
|
|
</summary>
|
|
<param name="count">Dictionary items count.</param>
|
|
<returns>This instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackRawHeader(System.Int32)">
|
|
<summary>
|
|
Bookkeep byte length to be packed on current stream.
|
|
</summary>
|
|
<param name="length">Byte length.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
This method acts as alias of <see cref="M:MsgPack.Packer.PackStringHeader(System.Int32)"/> for compatibility.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackStringHeader(System.Int32)">
|
|
<summary>
|
|
Bookkeep byte length to be packed on current stream as the bytes may represent well formed encoded string.
|
|
</summary>
|
|
<param name="length">Byte length.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackBinaryHeader(System.Int32)">
|
|
<summary>
|
|
Bookkeep byte length to be packed on current stream as the bytes do not represent well formed encoded string.
|
|
</summary>
|
|
<param name="length">Byte length.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackRawHeaderCore(System.Int32)">
|
|
<summary>
|
|
Bookkeep byte length to be packed on current stream.
|
|
</summary>
|
|
<param name="length">Byte length.</param>
|
|
<returns>This instance.</returns>
|
|
<remarks>
|
|
This method acts as alias of <see cref="M:MsgPack.Packer.PackStringHeaderCore(System.Int32)"/> for compatibility.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackStringHeaderCore(System.Int32)">
|
|
<summary>
|
|
Bookkeep byte length to be packed on current stream as the bytes may represent well formed encoded string.
|
|
</summary>
|
|
<param name="length">Byte length.</param>
|
|
<returns>This instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackBinaryHeaderCore(System.Int32)">
|
|
<summary>
|
|
Bookkeep byte length to be packed on current stream as the bytes do not represent well formed encoded string.
|
|
</summary>
|
|
<param name="length">Byte length.</param>
|
|
<returns>This instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackRaw(System.Collections.Generic.IEnumerable{System.Byte})">
|
|
<summary>
|
|
Packs specified byte stream to current stream.
|
|
</summary>
|
|
<param name="value">Source bytes its size is not known.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
This method use str types (previously known as raw types) for compability.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackRaw(System.Collections.Generic.IList{System.Byte})">
|
|
<summary>
|
|
Packs specified byte stream to current stream.
|
|
</summary>
|
|
<param name="value">Source bytes its size is known.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
This method use str types (previously known as raw types) for compability.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackRaw(System.Byte[])">
|
|
<summary>
|
|
Packs specified byte array to current stream.
|
|
</summary>
|
|
<param name="value">Source byte array.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
This method use str types (previously known as raw types) for compability.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackRawBody(System.Byte[])">
|
|
<summary>
|
|
Packs specified byte array to current stream without any header.
|
|
</summary>
|
|
<param name="value">Source byte array.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
If you forget to write header first, then resulting stream will be corrupsed.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackRawBody(System.Collections.Generic.IEnumerable{System.Byte})">
|
|
<summary>
|
|
Packs specified byte sequence to current stream without any header.
|
|
</summary>
|
|
<param name="value">Source byte array.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
If you forget to write header first, then resulting stream will be corrupsed.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackString(System.Collections.Generic.IEnumerable{System.Char})">
|
|
<summary>
|
|
Packs specified char stream to current stream with UTF-8 <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
<param name="value">Source chars its size is not known.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackString(System.String)">
|
|
<summary>
|
|
Packs specified string to current stream with UTF-8 <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
<param name="value">Source string.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackString(System.Collections.Generic.IEnumerable{System.Char},System.Text.Encoding)">
|
|
<summary>
|
|
Packs specified char stream to current stream with specified <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
<param name="value">Source chars its size is not known.</param>
|
|
<param name="encoding"><see cref="T:System.Text.Encoding"/> to be used.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackString(System.String,System.Text.Encoding)">
|
|
<summary>
|
|
Packs specified string to current stream with specified <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
<param name="value">Source string.</param>
|
|
<param name="encoding"><see cref="T:System.Text.Encoding"/> to be used.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackStringCore(System.Collections.Generic.IEnumerable{System.Char},System.Text.Encoding)">
|
|
<summary>
|
|
Packs specified char stream to current stream with specified <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
<param name="value">Source chars its size is not known.</param>
|
|
<param name="encoding"><see cref="T:System.Text.Encoding"/> to be used.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackStringCore(System.String,System.Text.Encoding)">
|
|
<summary>
|
|
Packs specified string to current stream with specified <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
<param name="value">Source string.</param>
|
|
<param name="encoding"><see cref="T:System.Text.Encoding"/> to be used.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackBinary(System.Collections.Generic.IEnumerable{System.Byte})">
|
|
<summary>
|
|
Packs specified byte stream to current stream.
|
|
</summary>
|
|
<param name="value">Source bytes its size is not known.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
This method use bin types unless <see cref="P:MsgPack.Packer.CompatibilityOptions"/> contains <see cref="F:MsgPack.PackerCompatibilityOptions.PackBinaryAsRaw"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackBinary(System.Collections.Generic.IList{System.Byte})">
|
|
<summary>
|
|
Packs specified byte stream to current stream.
|
|
</summary>
|
|
<param name="value">Source bytes its size is known.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
This method use bin types unless <see cref="P:MsgPack.Packer.CompatibilityOptions"/> contains <see cref="F:MsgPack.PackerCompatibilityOptions.PackBinaryAsRaw"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackBinary(System.Byte[])">
|
|
<summary>
|
|
Packs specified byte array to current stream.
|
|
</summary>
|
|
<param name="value">Source byte array.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
<remarks>
|
|
This method use bin types unless <see cref="P:MsgPack.Packer.CompatibilityOptions"/> contains <see cref="F:MsgPack.PackerCompatibilityOptions.PackBinaryAsRaw"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackArrayHeader``1(System.Collections.Generic.IList{``0})">
|
|
<summary>
|
|
Bookkeep collection count to be packed on current stream.
|
|
</summary>
|
|
<param name="array">Collection count to be written.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackMapHeader``2(System.Collections.Generic.IDictionary{``0,``1})">
|
|
<summary>
|
|
Bookkeep dictionary count to be packed on current stream.
|
|
</summary>
|
|
<param name="map">Dictionary count to be written.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackTinySignedInteger(System.Int64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.SByte"/> value to current stream as tiny fix num.
|
|
</summary>
|
|
<param name="value">Maybe tiny <see cref="T:System.SByte"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.TryPackTinyUnsignedInteger(System.UInt64)">
|
|
<summary>
|
|
Try packs <see cref="T:System.Byte"/> value to current stream as tiny fix num.
|
|
</summary>
|
|
<param name="value">Maybe tiny <see cref="T:System.Byte"/> value.</param>
|
|
<returns>If <paramref name="value"/> has be packed successfully then true, otherwise false (normally, larger type required).</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackNull">
|
|
<summary>
|
|
Packs a null value to current stream.
|
|
</summary>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackExtendedTypeValue(System.Byte,System.Byte[])">
|
|
<summary>
|
|
Packs an extended type value.
|
|
</summary>
|
|
<param name="typeCode">A type code of the extended type value.</param>
|
|
<param name="body">A binary value portion of the extended type value.</param>
|
|
<returns>This instance. </returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="body"/> is <c>null</c>.</exception>
|
|
<exception cref="T:System.InvalidOperationException"><see cref="P:MsgPack.Packer.CompatibilityOptions"/> property contains <see cref="F:MsgPack.PackerCompatibilityOptions.ProhibitExtendedTypeObjects"/>.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.PackExtendedTypeValue(MsgPack.MessagePackExtendedTypeObject)">
|
|
<summary>
|
|
Packs an extended type value.
|
|
</summary>
|
|
<param name="mpeto">A <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> to be packed.</param>
|
|
<returns>This instance.</returns>
|
|
<exception cref="T:System.ArgumentException"><see cref="P:MsgPack.MessagePackExtendedTypeObject.IsValid"/> of <paramref name="mpeto"/> is <c>false</c>.</exception>
|
|
<exception cref="T:System.InvalidOperationException"><see cref="P:MsgPack.Packer.CompatibilityOptions"/> property contains <see cref="F:MsgPack.PackerCompatibilityOptions.ProhibitExtendedTypeObjects"/>.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">This instance has been disposed.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.SByte})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.SByte"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.Byte})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.Byte"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.Int16})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.Int16"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.UInt16})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.UInt16"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.Int32})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.Int32"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.UInt32})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.UInt32"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.Int64})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.Int64"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.UInt64})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.UInt64"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.Single})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.Single"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.Double})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.Double"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Packer.Pack(System.Nullable{System.Boolean})">
|
|
<summary>
|
|
Pack nullable <see cref="T:System.Boolean"/> value.
|
|
</summary>
|
|
<param name="value">Value to serialize.</param>
|
|
<returns>This packer instance.</returns>
|
|
</member>
|
|
<member name="P:MsgPack.Packer.DefaultCompatibilityOptions">
|
|
<summary>
|
|
Gets or sets the default <see cref="T:MsgPack.PackerCompatibilityOptions"/> for all instances.
|
|
</summary>
|
|
<value>
|
|
The default <see cref="T:MsgPack.PackerCompatibilityOptions"/>.
|
|
The default value is <see cref="F:MsgPack.PackerCompatibilityOptions.Classic"/>.
|
|
</value>
|
|
<remarks>
|
|
<para>
|
|
Note that modification of this value will affect all new instances from the point.
|
|
Existent instances are not afectted by the modification.
|
|
</para>
|
|
<para>
|
|
This property is intended to be set in application initialization code.
|
|
</para>
|
|
<para>
|
|
Note that the default value is <see cref="F:MsgPack.PackerCompatibilityOptions.Classic"/>, not <see cref="F:MsgPack.PackerCompatibilityOptions.None"/>.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Packer.CanSeek">
|
|
<summary>
|
|
Get whether this class supports seek operation and quering <see cref="P:MsgPack.Packer.Position"/> property.
|
|
</summary>
|
|
<value>If this class supports seek operation and quering <see cref="P:MsgPack.Packer.Position"/> property then true.</value>
|
|
</member>
|
|
<member name="P:MsgPack.Packer.Position">
|
|
<summary>
|
|
Get current position of underlying stream.
|
|
</summary>
|
|
<value>Opaque position value of underlying stream.</value>
|
|
<exception cref="T:System.NotSupportedException">
|
|
A class of this instance does not support seek.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.Packer.CompatibilityOptions">
|
|
<summary>
|
|
Gets a compatibility options for this instance.
|
|
</summary>
|
|
<value>
|
|
The compatibility options.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.PackerCompatibilityOptions">
|
|
<summary>
|
|
Defines compatibility options for <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.PackerCompatibilityOptions.None">
|
|
<summary>
|
|
No compatibility options. <see cref="T:MsgPack.Packer"/>s use newest behavior.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.PackerCompatibilityOptions.PackBinaryAsRaw">
|
|
<summary>
|
|
Packs byte array as raw(str) value, and also prohibits usage of str8 type for legacy unpacker implementations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.PackerCompatibilityOptions.ProhibitExtendedTypeObjects">
|
|
<summary>
|
|
Prohibits usage of any ext types for legacy unpacker implementations.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.PackerCompatibilityOptions.Classic">
|
|
<summary>
|
|
<see cref="T:MsgPack.Packer"/>s should be use classic behavior. That is, do not use str8 and any ext types, and byte arrays must be packed as raw.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.PackerUnpackerExtensions">
|
|
<summary>
|
|
Defines extension method to pack or unpack various objects.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.Pack``1(MsgPack.Packer,``0)">
|
|
<summary>
|
|
Packs specified value with the default context.
|
|
</summary>
|
|
<typeparam name="T">The type of the value.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="value">The value to be serialized.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="value"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.Pack``1(MsgPack.Packer,``0,MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Packs specified value with the specified context.
|
|
</summary>
|
|
<typeparam name="T">The type of the value.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="value">The value to be serialized.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="value"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackArray``1(MsgPack.Packer,System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Packs specified collection with the default context.
|
|
</summary>
|
|
<typeparam name="T">The type of items of the collection.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="collection">The collection to be serialized.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="collection"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackArray``1(MsgPack.Packer,System.Collections.Generic.IEnumerable{``0},MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Packs specified collection with the specified context.
|
|
</summary>
|
|
<typeparam name="T">The type of items of the collection.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="collection">The collection to be serialized.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="collection"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackCollection``1(MsgPack.Packer,System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Packs specified collection with the default context.
|
|
</summary>
|
|
<typeparam name="T">The type of items of the collection.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="collection">The collection to be serialized.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="collection"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackCollection``1(MsgPack.Packer,System.Collections.Generic.IEnumerable{``0},MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Packs specified collection with the specified context.
|
|
</summary>
|
|
<typeparam name="T">The type of items of the collection.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="collection">The collection to be serialized.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="collection"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackMap``2(MsgPack.Packer,System.Collections.Generic.IDictionary{``0,``1})">
|
|
<summary>
|
|
Packs specified dictionary with the default context.
|
|
</summary>
|
|
<typeparam name="TKey">The type of keys of the dictionary.</typeparam>
|
|
<typeparam name="TValue">The type of values of the dictionary.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="dictionary">The dictionary to be serialized.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="dictionary"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackMap``2(MsgPack.Packer,System.Collections.Generic.IDictionary{``0,``1},MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Packs specified dictionary with the specified context.
|
|
</summary>
|
|
<typeparam name="TKey">The type of keys of the dictionary.</typeparam>
|
|
<typeparam name="TValue">The type of values of the dictionary.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="dictionary">The dictionary to be serialized.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="dictionary"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackDictionary``2(MsgPack.Packer,System.Collections.Generic.IDictionary{``0,``1})">
|
|
<summary>
|
|
Packs specified dictionary with the default context.
|
|
</summary>
|
|
<typeparam name="TKey">The type of keys of the dictionary.</typeparam>
|
|
<typeparam name="TValue">The type of values of the dictionary.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="dictionary">The dictionary to be serialized.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="dictionary"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackDictionary``2(MsgPack.Packer,System.Collections.Generic.IDictionary{``0,``1},MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Packs specified dictionary with the specified context.
|
|
</summary>
|
|
<typeparam name="TKey">The type of keys of the dictionary.</typeparam>
|
|
<typeparam name="TValue">The type of values of the dictionary.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="dictionary">The dictionary to be serialized.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="dictionary"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.Pack``1(MsgPack.Packer,System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Packs specified collection with the default context.
|
|
</summary>
|
|
<typeparam name="T">The type of the value.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="items">The collection to be serialized.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize the item of <paramref name="items"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.Pack``1(MsgPack.Packer,System.Collections.Generic.IEnumerable{``0},MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Packs specified value with the specified context.
|
|
</summary>
|
|
<typeparam name="T">The type of the value.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="items">The collection to be serialized.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize the item of <paramref name="items"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackObject(MsgPack.Packer,System.Object)">
|
|
<summary>
|
|
Packs specified value with the default context.
|
|
</summary>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="value">The value to be serialized.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="value"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.PackObject(MsgPack.Packer,System.Object,MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Packs specified value with the specified context.
|
|
</summary>
|
|
<param name="source">The <see cref="T:MsgPack.Packer"/>.</param>
|
|
<param name="value">The value to be serialized.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns><paramref name="source"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot serialize <paramref name="value"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.Unpack``1(MsgPack.Unpacker)">
|
|
<summary>
|
|
Unpacks specified type value with the default context.
|
|
</summary>
|
|
<typeparam name="T">The type of the value.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Unpacker"/>.</param>
|
|
<returns>The deserialized value.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot deserialize <typeparamref name="T"/> value.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.PackerUnpackerExtensions.Unpack``1(MsgPack.Unpacker,MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Unpacks specified type value with the specified context.
|
|
</summary>
|
|
<typeparam name="T">The type of the value.</typeparam>
|
|
<param name="source">The <see cref="T:MsgPack.Unpacker"/>.</param>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> holds shared serializers.</param>
|
|
<returns>The deserialized value.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Cannot deserialize <typeparamref name="T"/> value.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.PackingOptions">
|
|
<summary>
|
|
Represents options of packing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.PackingOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.PackingOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.PackingOptions.StringEncoding">
|
|
<summary>
|
|
Get encoding for string.
|
|
</summary>
|
|
<value>
|
|
<see cref="T:System.Text.Encoding"/> for string. Default is UTF-8 encoding without BOM.
|
|
</value>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.AbstractSerializers.EnumSerializerMethod.PackUnderlyingValueTo">
|
|
<summary>
|
|
void PackUnderlyingValueTo(Packer, TEnum)
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.AbstractSerializers.EnumSerializerMethod.UnpackFromUnderlyingValue">
|
|
<summary>
|
|
TEnum UnpackFromUnderlyingValue(MessagePackObject)
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.AbstractSerializers.ICodeConstruct">
|
|
<summary>
|
|
Defines a common interface for code construct which abstracts code constructs used in serializer builders.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.ICodeConstruct.ContextType">
|
|
<summary>
|
|
Gets the context type of this construct.
|
|
</summary>
|
|
<value>
|
|
The context type of this construct.
|
|
This value will not be <c>null</c>, but might be <see cref="T:System.Void"/>.
|
|
</value>
|
|
<remarks>
|
|
A context type represents evaluation context for IL emitting or expression type for Expression Tree.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.AbstractSerializers.ISerializerBuilder`1">
|
|
<summary>
|
|
Defines a common interface for serializer builder.
|
|
</summary>
|
|
<typeparam name="TObject">The type of the serializing object.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.ISerializerBuilder`1.BuildSerializerInstance(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Builds the serializer and returns its new instance.
|
|
</summary>
|
|
<param name="context">The context information.</param>
|
|
<returns>
|
|
Newly created serializer object.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3">
|
|
<summary>
|
|
Defines common features for serializer builder.
|
|
</summary>
|
|
<typeparam name="TContext">The type of the context which holds global information for generating serializer.</typeparam>
|
|
<typeparam name="TConstruct">The type of the construct which abstracts code constructs.</typeparam>
|
|
<typeparam name="TObject">The type of the object which will be target of the generating serializer.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitMethodPrologue(`0,MsgPack.Serialization.AbstractSerializers.SerializerMethod)">
|
|
<summary>
|
|
Emits the method prologue of general serializer.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="serializerMethod">The kind of implementing general serializer method.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitMethodPrologue(`0,MsgPack.Serialization.AbstractSerializers.EnumSerializerMethod)">
|
|
<summary>
|
|
Emits the method prologue of enum serializer.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="enumSerializerMethod">The kind of implementing enum serializer method.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitMethodEpilogue(`0,MsgPack.Serialization.AbstractSerializers.SerializerMethod,`1)">
|
|
<summary>
|
|
Emits the method epiloigue of general serializer.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="serializerMethod">The kind of implementing general serializer method.</param>
|
|
<param name="construct">The construct which represent method statements in order. Null entry should be ignored.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitMethodEpilogue(`0,MsgPack.Serialization.AbstractSerializers.EnumSerializerMethod,`1)">
|
|
<summary>
|
|
Emits the method epiloigue of enum serializer.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="enumSerializerMethod">The kind of implementing enum serializer method.</param>
|
|
<param name="construct">The construct which represent method statements in order. Null entry should be ignored.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.MakeNullLiteral(`0,System.Type)">
|
|
<summary>
|
|
Emits anonymous <c>null</c> reference literal.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="contextType">The type of null reference.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.MakeInt32Literal(`0,System.Int32)">
|
|
<summary>
|
|
Emits the constant <see cref="T:System.Int32"/> value reference.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="constant">The constant value.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.MakeInt64Literal(`0,System.Int64)">
|
|
<summary>
|
|
Emits the constant <see cref="T:System.Int64"/> value reference.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="constant">The constant value.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.MakeStringLiteral(`0,System.String)">
|
|
<summary>
|
|
Emits the constant <see cref="T:System.String"/> value reference.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="constant">The constant value.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.MakeEnumLiteral(`0,System.Type,System.Object)">
|
|
<summary>
|
|
Emits the constant enum value reference.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="type">The type the enum.</param>
|
|
<param name="constant">The constant value.</param>
|
|
<returns>The generated construct.</returns>
|
|
<exception cref="T:System.ArgumentException"><paramref name="type"/> is not enum.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitThisReferenceExpression(`0)">
|
|
<summary>
|
|
Emits the loading this reference expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitBoxExpression(`0,System.Type,`1)">
|
|
<summary>
|
|
Emits the box expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="valueType">Type of the value to be boxed.</param>
|
|
<param name="value">The value to be boxed.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitUnboxAnyExpression(`0,System.Type,`1)">
|
|
<summary>
|
|
Emits the cast or unbox expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="targetType">Type of the value to be casted or be unboxed.</param>
|
|
<param name="value">The value to be casted or be unboxed.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitNotExpression(`0,`1)">
|
|
<summary>
|
|
Emits the not expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="booleanExpression">The boolean expression to be .</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitEqualsExpression(`0,`1,`1)">
|
|
<summary>
|
|
Emits the equals expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="left">The left expression.</param>
|
|
<param name="right">The right expression.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitNotEqualsExpression(`0,`1,`1)">
|
|
<summary>
|
|
Emits the not equals expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="left">The left expression.</param>
|
|
<param name="right">The right expression.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitGreaterThanExpression(`0,`1,`1)">
|
|
<summary>
|
|
Emits the greater than expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="left">The left expression.</param>
|
|
<param name="right">The right expression.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitLessThanExpression(`0,`1,`1)">
|
|
<summary>
|
|
Emits the less than expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="left">The left expression.</param>
|
|
<param name="right">The right expression.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitIncrement(`0,`1)">
|
|
<summary>
|
|
Emits the unary increment expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="int32Value">The int32 value to be incremented.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitTypeOfExpression(`0,System.Type)">
|
|
<summary>
|
|
Emits the elementType-of expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="type">The elementType.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitSequentialStatements(`0,System.Type,`1[])">
|
|
<summary>
|
|
Emits the sequential statements. Note that the context elementType is void.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="contextType">The type of context.</param>
|
|
<param name="statements">The statements.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitSequentialStatements(`0,System.Type,System.Collections.Generic.IEnumerable{`1})">
|
|
<summary>
|
|
Emits the sequential statements. Note that the context elementType is void.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="contextType">The type of context.</param>
|
|
<param name="statements">The statements.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.ReferArgument(`0,System.Type,System.String,System.Int32)">
|
|
<summary>
|
|
Creates the argument reference.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="type">The type of the parameter for debugging puropose.</param>
|
|
<param name="name">The name of the parameter.</param>
|
|
<param name="index">The index of the parameters.</param>
|
|
<returns>
|
|
The generated construct which represents an argument reference.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.DeclareLocal(`0,System.Type,System.String)">
|
|
<summary>
|
|
Declares the local variable.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="type">The elementType of the variable.</param>
|
|
<param name="name">The name of the variable for debugging puropose.</param>
|
|
<returns>
|
|
The generated construct which represents local variable declaration AND initialization, and reference.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitCreateNewObjectExpression(`0,`1,System.Reflection.ConstructorInfo,`1[])">
|
|
<summary>
|
|
Emits the create new object expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="variable">The variable which will store created value type object.</param>
|
|
<param name="constructor">The constructor.</param>
|
|
<param name="arguments">The arguments.</param>
|
|
<returns>
|
|
The generated construct which represents new obj instruction.
|
|
Note that created object remains in context.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitInvokeVoidMethod(`0,`1,System.Reflection.MethodInfo,`1[])">
|
|
<summary>
|
|
Emits the invoke void method.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance for instance method invocation. <c>null</c> for static method.</param>
|
|
<param name="method">The method to be invoked.</param>
|
|
<param name="arguments">The arguments to be passed.</param>
|
|
<returns>
|
|
The generated construct.
|
|
</returns>
|
|
<remarks>
|
|
The derived class must emits codes which discard return non-void value.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitInvokeMethodExpression(`0,`1,System.Reflection.MethodInfo,`1[])">
|
|
<summary>
|
|
Emits the invoke non-void method.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance for instance method invocation. <c>null</c> for static method.</param>
|
|
<param name="method">The method to be invoked.</param>
|
|
<param name="arguments">The arguments to be passed.</param>
|
|
<returns>
|
|
The generated construct which represents new obj instruction.
|
|
Note that returned value remains in context.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitInvokeMethodExpression(`0,`1,System.Reflection.MethodInfo,System.Collections.Generic.IEnumerable{`1})">
|
|
<summary>
|
|
Emits the invoke non-void method.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance for instance method invocation. <c>null</c> for static method.</param>
|
|
<param name="method">The method to be invoked.</param>
|
|
<param name="arguments">The arguments to be passed.</param>
|
|
<returns>
|
|
The generated construct which represents new obj instruction.
|
|
Note that returned value remains in context.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitGetMemberValueExpression(`0,`1,System.Reflection.MemberInfo)">
|
|
<summary>
|
|
Emits the get member(field or property) value expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance which stores instance member value.</param>
|
|
<param name="member">The member to be accessed.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitGetPropretyExpression(`0,`1,System.Reflection.PropertyInfo)">
|
|
<summary>
|
|
Emits the get property value expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance which stores instance member value.</param>
|
|
<param name="property">The property to be accessed.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitGetFieldExpression(`0,`1,System.Reflection.FieldInfo)">
|
|
<summary>
|
|
Emits the get field value expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance which stores instance member value.</param>
|
|
<param name="field">The field to be accessed.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitSetMemberValueStatement(`0,`1,System.Reflection.MemberInfo,`1)">
|
|
<summary>
|
|
Emits the set member(property or field) value statement.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance which stores instance member value.</param>
|
|
<param name="member">The member to be accessed.</param>
|
|
<param name="value">The value to be stored.</param>
|
|
<returns>The generated construct.</returns>
|
|
<remarks>
|
|
This method generates <c>collection.Add(value)</c> constructs for a read-only member.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitMethodOfExpression(`0,System.Reflection.MethodBase)">
|
|
<summary>
|
|
Emits the 'methodof' expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="method">The method to be retrieved.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitSetProprety(`0,`1,System.Reflection.PropertyInfo,`1)">
|
|
<summary>
|
|
Emits the set property value statement.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance which stores instance member value.</param>
|
|
<param name="property">The property to be accessed.</param>
|
|
<param name="value">The value to be stored.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitFieldOfExpression(`0,System.Reflection.FieldInfo)">
|
|
<summary>
|
|
Emits the 'fieldof' expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="field">The field to be retrieved.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitSetField(`0,`1,System.Reflection.FieldInfo,`1)">
|
|
<summary>
|
|
Emits the set field value statement.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="instance">The instance which stores instance member value.</param>
|
|
<param name="field">The field to be accessed.</param>
|
|
<param name="value">The value to be stored.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitLoadVariableExpression(`0,`1)">
|
|
<summary>
|
|
Emits the statement which loads value from the local variable.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="variable">The variable to be loaded.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitStoreVariableStatement(`0,`1)">
|
|
<summary>
|
|
Emits the statement which stores context value to the local variable.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="variable">The variable to be stored.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitStoreVariableStatement(`0,`1,`1)">
|
|
<summary>
|
|
Emits the statement which stores specified value to the local variable.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="variable">The variable to be stored.</param>
|
|
<param name="value">The value to be stored. <c>null</c> for context value.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitThrowExpression(`0,System.Type,System.Reflection.MethodInfo,`1[])">
|
|
<summary>
|
|
Emits the throwing exception statement.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="expressionType">Type of the entire expression elementType.</param>
|
|
<param name="factoryMethod">The factory method which creates exception object with <paramref name="arguments"/>.</param>
|
|
<param name="arguments">The arguments of <paramref name="factoryMethod"/>.</param>
|
|
<returns>The generated construct.</returns>
|
|
<remarks>
|
|
The expression elementType is required to acomplish condition expression.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitThrowExpression(`0,System.Type,`1)">
|
|
<summary>
|
|
Emits the throwing exception statement.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="expressionType">Type of the entire expression elementType.</param>
|
|
<param name="exceptionExpression">The expression of throwing exception.</param>
|
|
<returns>The generated construct.</returns>
|
|
<remarks>
|
|
The expression elementType is required to acomplish condition expression.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitTryFinally(`0,`1,`1)">
|
|
<summary>
|
|
Emits the try-finally expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="tryStatement">The try expression.</param>
|
|
<param name="finallyStatement">The finally statement.</param>
|
|
<returns>The generated construct which elementType is elementType of <paramref name="tryStatement"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitInvariantStringFormat(`0,System.String,`1[])">
|
|
<summary>
|
|
Emits the invariant <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> with <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="format">The format string literal.</param>
|
|
<param name="arguments">The arguments to be used.</param>
|
|
<returns>The generated construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitCreateNewArrayExpression(`0,System.Type,System.Int32,System.Collections.Generic.IEnumerable{`1})">
|
|
<summary>
|
|
Emits the create new array expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="elementType">The elementType of the array element.</param>
|
|
<param name="length">The length of the array.</param>
|
|
<param name="initialElements">The initial elements of the array.</param>
|
|
<returns>The generated code construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitGetCollectionCountExpression(`0,`1,MsgPack.Serialization.CollectionTraits)">
|
|
<summary>
|
|
Emits the code which gets collection count.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="collection">The collection reference.</param>
|
|
<param name="traits">The collection traits.</param>
|
|
<returns>The generated code construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitGetSerializerExpression(`0,System.Type,System.Nullable{MsgPack.Serialization.SerializingMember})">
|
|
<summary>
|
|
Emits the get serializer expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="targetType">Type of the target of the serializer.</param>
|
|
<param name="memberInfo">The metadata of the packing/unpacking member.</param>
|
|
<returns>The generated code construct.</returns>
|
|
<remarks>
|
|
The serializer reference methodology is implication specific.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitPackItemStatements(`0,`1,System.Type,MsgPack.Serialization.NilImplication,System.String,`1,System.Nullable{MsgPack.Serialization.SerializingMember})">
|
|
<summary>
|
|
Emits the pack item expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="packer">The packer.</param>
|
|
<param name="itemType">Type of the item.</param>
|
|
<param name="nilImplication">The nil implication of the member.</param>
|
|
<param name="memberName">Name of the member.</param>
|
|
<param name="item">The item to be packed.</param>
|
|
<param name="memberInfo">The metadata of packing member. <c>null</c> for non-object member (collection or tuple items).</param>
|
|
<returns>The generated code construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitGetItemsCountExpression(`0,`1)">
|
|
<summary>
|
|
Emits the get items count expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="unpacker">The target unpacker.</param>
|
|
<returns>The generated code construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitUnpackCollectionWithUnpackToExpression(`0,System.Reflection.ConstructorInfo,`1,`1,`1)">
|
|
<summary>
|
|
Emits the UnpackFrom body for collection which delegates UnpackTo.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="ctor">The constructor of the newly creating collection.</param>
|
|
<param name="collectionCapacity">The newly creating collection capacity.</param>
|
|
<param name="unpacker">The unpacker.</param>
|
|
<param name="collection">The unpacking collection.</param>
|
|
<returns>The generated code construct.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitUnpackItemValueExpression(`0,System.Type,MsgPack.Serialization.NilImplication,`1,`1,`1,`1,`1,System.Nullable{MsgPack.Serialization.SerializingMember},System.Func{`1,`1})">
|
|
<summary>
|
|
Emits the unpack item value expression.
|
|
</summary>
|
|
<param name="context">The context.</param>
|
|
<param name="itemType">Type of the item.</param>
|
|
<param name="nilImplication">The nil implication.</param>
|
|
<param name="unpacker">The reference to the unpacker.</param>
|
|
<param name="itemIndex">Index of the item.</param>
|
|
<param name="memberName">Name of the member.</param>
|
|
<param name="itemsCount">
|
|
The reference to items count init-only local variable which remember unpackable items count.
|
|
This value will be <c>null</c> for tuples and collections.
|
|
</param>
|
|
<param name="unpacked">
|
|
The reference to unpacked items count local variable which remember unpacked items count.
|
|
This value will be <c>null</c> for tuples and collections.
|
|
</param>
|
|
<param name="memberInfo">The metadata of unpacking member.</param>
|
|
<param name="storeValueStatementEmitter">
|
|
The delegate which generates statement for storing unpacked value.
|
|
1st parameter is unpacked value, and return value is generated statement.
|
|
</param>
|
|
<returns>The sequential statement.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitUnpackItemValueExpressionCore(`0,System.Type,MsgPack.Serialization.NilImplication,`1,`1,`1,`1,`1,System.Nullable{MsgPack.Serialization.SerializingMember},System.Func{`1,`1})">
|
|
<summary>
|
|
Emits the unpack item value expression.
|
|
</summary>
|
|
<param name="context">The context.</param>
|
|
<param name="itemType">Type of the item.</param>
|
|
<param name="nilImplication">The nil implication.</param>
|
|
<param name="unpacker">The reference to the unpacker.</param>
|
|
<param name="itemIndex">Index of the item.</param>
|
|
<param name="memberName">Name of the member.</param>
|
|
<param name="itemsCount">
|
|
The reference to items count init-only local variable which remember unpackable items count.
|
|
This value will be <c>null</c> for tuples and collections.
|
|
</param>
|
|
<param name="unpacked">
|
|
The reference to unpacked items count local variable which remember unpacked items count.
|
|
This value will be <c>null</c> for tuples and collections.
|
|
</param>
|
|
<param name="memberInfo">The metadata of unpacking member.</param>
|
|
<param name="storeValueStatementEmitter">
|
|
The delegate which generates statement for storing unpacked value.
|
|
1st parameter is unpacked value, and return value is generated statement.
|
|
</param>
|
|
<returns>The elements of sequential statement.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitUsingStatement(`0,System.Type,`1,System.Func{`1,`1})">
|
|
<summary>
|
|
Emits the using expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="disposableType">Type of the disposable.</param>
|
|
<param name="instantiateIDisposableExpression">The expression which instantiate <see cref="T:System.IDisposable"/> object.</param>
|
|
<param name="usingBodyEmitter">The using body which takes disposable object and returns actual statement.</param>
|
|
<returns>The using statement.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitDeserializeItemExpression(`0,`1,System.Type,`1,System.Nullable{MsgPack.Serialization.SerializingMember})">
|
|
<summary>
|
|
Emits the deserialize item expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="unpacker">The unpacker expression.</param>
|
|
<param name="itemType">Type of the item to be deserialized.</param>
|
|
<param name="unpacked">The variable which stores unpacked item.</param>
|
|
<param name="memberInfo">The metadata of unpacking member.</param>
|
|
<returns>The expression which returns deserialized item.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitConditionalExpression(`0,`1,`1,`1)">
|
|
<summary>
|
|
Emits the conditional expression (cond?then:else).
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="conditionExpression">The expression which represents conditional.</param>
|
|
<param name="thenExpression">The expression which is used when condition is true.</param>
|
|
<param name="elseExpression">The expression which is used when condition is false.</param>
|
|
<returns>The conditional expression.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitAndConditionalExpression(`0,System.Collections.Generic.IList{`1},`1,`1)">
|
|
<summary>
|
|
Emits the conditional expression (cond?then:else) which has short circuit and expression.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="conditionExpressions">The expression which represents short circuit and expression.</param>
|
|
<param name="thenExpression">The expression which is used when condition is true.</param>
|
|
<param name="elseExpression">The expression which is used when condition is false.</param>
|
|
<returns>The conditional expression.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitStringSwitchStatement(`0,`1,System.Collections.Generic.IDictionary{System.String,`1})">
|
|
<summary>
|
|
Emits string switch statement.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="target">Target string expression.</param>
|
|
<param name="cases">The case statements. The keys are case condition, and values are actual statement.</param>
|
|
<returns>The switch statement.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitRetrunStatement(`0,`1)">
|
|
<summary>
|
|
Emits the return statement
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="expression">The expression to be returned.</param>
|
|
<returns>The return statement.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitForLoop(`0,`1,System.Func{MsgPack.Serialization.AbstractSerializers.SerializerBuilder{`0,`1,`2}.ForLoopContext,`1})">
|
|
<summary>
|
|
Emits the for loop.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="count">The count reference for loop terminiation condition.</param>
|
|
<param name="loopBodyEmitter">The loop body emitter which takes for loop context then returns loop body construct.</param>
|
|
<returns>The for loop.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitForEachLoop(`0,MsgPack.Serialization.CollectionTraits,`1,System.Func{`1,`1})">
|
|
<summary>
|
|
Emits the for-each loop.
|
|
</summary>
|
|
<param name="context">The generation context.</param>
|
|
<param name="collectionTraits">The traits of the collection.</param>
|
|
<param name="collection">The collection reference.</param>
|
|
<param name="loopBodyEmitter">The loop body emitter which takes item reference then returns loop body construct.</param>
|
|
<returns>The for each loop.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.EmitAppendCollectionItem(`0,System.Reflection.MemberInfo,MsgPack.Serialization.CollectionTraits,`1,`1)">
|
|
<summary>
|
|
Emits the append collection item.
|
|
</summary>
|
|
<param name="context">The code generation context.</param>
|
|
<param name="member">The read only collection member metadata. <c>null</c> for collection item.</param>
|
|
<param name="traits">The traits of the collection.</param>
|
|
<param name="collection">The collection to be appended.</param>
|
|
<param name="unpackedItem">The unpacked item.</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.GetDefaultConstructor(System.Type)">
|
|
<summary>
|
|
Retrieves a default constructor of the specified elementType.
|
|
</summary>
|
|
<param name="instanceType">The target elementType.</param>
|
|
<returns>A default constructor of the <paramref name="instanceType"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.GetCollectionConstructor(System.Type)">
|
|
<summary>
|
|
Retrieves a constructor with <see cref="T:System.Int32"/> elementType capacity parameter or default constructor of the <typeparamref name="TObject"/>.
|
|
</summary>
|
|
<param name="instanceType">The target elementType.</param>
|
|
<returns>A constructor of the <paramref name="instanceType"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.BuildSerializerInstance(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Builds the serializer and returns its new instance.
|
|
</summary>
|
|
<param name="context">The context information.</param>
|
|
<returns>
|
|
Newly created serializer object.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.CreateCodeGenerationContextForSerializerCreation(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Creates the code generation context for serializer instance creation.
|
|
</summary>
|
|
<param name="context">The serialization context.</param>
|
|
<returns>
|
|
The code generation context for serializer instance creation.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.BuildSerializer(`0)">
|
|
<summary>
|
|
Builds the serializer and returns its new instance.
|
|
</summary>
|
|
<param name="context">The context information. This value will not be <c>null</c>.</param>
|
|
<returns>
|
|
Newly created serializer object.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.CreateSerializerConstructor(`0)">
|
|
<summary>
|
|
Creates the serializer type and returns its constructor.
|
|
</summary>
|
|
<param name="codeGenerationContext">The code generation context.</param>
|
|
<returns>
|
|
<see cref="T:System.Func`2"/> which refers newly created constructor.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.CreateEnumSerializerConstructor(`0)">
|
|
<summary>
|
|
Creates the enum serializer type and returns its constructor.
|
|
</summary>
|
|
<param name="codeGenerationContext">The code generation context.</param>
|
|
<returns>
|
|
<see cref="T:System.Func`2"/> which refers newly created constructor.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.ForLoopContext">
|
|
<summary>
|
|
Represents for-loop context information.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3.ForLoopContext.Counter">
|
|
<summary>
|
|
Gets the counter variable (<c>i</c>).
|
|
</summary>
|
|
<value>
|
|
The counter variable.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.NilImplicationHandler`4">
|
|
<summary>
|
|
Defines base features to handle nil implication.
|
|
</summary>
|
|
<typeparam name="TAction">The type of the actual action for handking.</typeparam>
|
|
<typeparam name="TCondition">The type of the condition for packing value nil check.</typeparam>
|
|
<typeparam name="TPackingParameter">The type of the implementation specific on-packing methods parameter.</typeparam>
|
|
<typeparam name="TUnpackedParameter">The type of the implementation specific on-unpacked methods parameter.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.INilImplicationHandlerParameter">
|
|
<summary>
|
|
Defines common interface for parameter of <see cref="M:MsgPack.Serialization.NilImplicationHandler`4.OnPacking(`2,MsgPack.Serialization.NilImplication)"/> method and its template methods.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.INilImplicationHandlerOnUnpackedParameter`1">
|
|
<summary>
|
|
Defines common interface for parameter of <see cref="M:MsgPack.Serialization.NilImplicationHandler`4.OnUnpacked(`3,MsgPack.Serialization.NilImplication)"/> method and its template methods.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.AbstractSerializers.SerializerFieldKey">
|
|
<summary>
|
|
Represents dictionary key to remember fields which store dependent serializer instance.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.AbstractSerializers.SerializerFieldKey.TypeHandle">
|
|
<summary>
|
|
Type of serializing/deserializing type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.AbstractSerializers.SerializerFieldKey.EnumSerializationMethod">
|
|
<summary>
|
|
Enum serialization method for specific member.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1">
|
|
<summary>
|
|
Defines common interfaces and features for context objects for serializer generation.
|
|
</summary>
|
|
<typeparam name="TConstruct">The contextType of the code construct for serializer builder.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.#ctor(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1"/> class.
|
|
</summary>
|
|
<param name="context">The serialization context.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.Reset(System.Type)">
|
|
<summary>
|
|
Resets internal states for specified target type.
|
|
</summary>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.ResetCore(System.Type)">
|
|
<summary>
|
|
Resets internal states for specified target type.
|
|
</summary>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.SerializationContext">
|
|
<summary>
|
|
Gets the serialization context which holds various serialization configuration.
|
|
</summary>
|
|
<value>
|
|
The serialization context. This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.Packer">
|
|
<summary>
|
|
Gets the code construct which represents the argument for the packer.
|
|
</summary>
|
|
<value>
|
|
The code construct which represents the argument for the packer.
|
|
This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.PackToTarget">
|
|
<summary>
|
|
Gets the code construct which represents the argument for the packing target object tree root.
|
|
</summary>
|
|
<returns>
|
|
The code construct which represents the argument for the packing target object tree root.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.Unpacker">
|
|
<summary>
|
|
Gets the code construct which represents the argument for the unpacker.
|
|
</summary>
|
|
<value>
|
|
The code construct which represents the argument for the unpacker.
|
|
This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.UnpackToTarget">
|
|
<summary>
|
|
Gets the code construct which represents the argument for the collection which will hold unpacked items.
|
|
</summary>
|
|
<returns>
|
|
The code construct which represents the argument for the collection which will hold unpacked items.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.CollectionItemNilImplication">
|
|
<summary>
|
|
Gets the configured nil-implication for collection items.
|
|
</summary>
|
|
<value>
|
|
The configured nil-implication for collection items.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.DictionaryKeyNilImplication">
|
|
<summary>
|
|
Gets the configured nil-implication for dictionary keys.
|
|
</summary>
|
|
<value>
|
|
The configured nil-implication for dictionary keys.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1.TupleItemNilImplication">
|
|
<summary>
|
|
Gets the configured nil-implication for tuple items.
|
|
</summary>
|
|
<value>
|
|
The configured nil-implication for tuple items.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.AutoMessagePackSerializer`1">
|
|
<summary>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> based on reflection, opt-out based.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.MessagePackSerializer`1">
|
|
<summary>
|
|
Defines base contract for object serialization.
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<remarks>
|
|
<para>
|
|
This class implements strongly typed serialization and deserialization.
|
|
</para>
|
|
<para>
|
|
When the underlying stream does not contain strongly typed or contains dynamically typed objects,
|
|
you should use <see cref="T:MsgPack.Unpacker"/> directly and take advantage of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</para>
|
|
</remarks>
|
|
<seealso cref="T:MsgPack.Unpacker"/>
|
|
<seealso cref="T:MsgPack.Unpacking"/>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer">
|
|
<summary>
|
|
Defines non-generic message pack serializer interface for byte array which contains a single object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.IMessagePackSerializer">
|
|
<summary>
|
|
Defines non-generic message pack serializer interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.IMessagePackSerializer.PackTo(MsgPack.Packer,System.Object)">
|
|
<summary>
|
|
Serialize specified object with specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
<param name="packer"><see cref="T:MsgPack.Packer"/> which packs values in <paramref name="objectTree"/>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="packer"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="objectTree"/> is not compatible for this serializer.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
The type of <paramref name="objectTree"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.IMessagePackSerializer.UnpackFrom(MsgPack.Unpacker)">
|
|
<summary>
|
|
Deserialize object with specified <see cref="T:MsgPack.Unpacker"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree.</param>
|
|
<returns>Deserialized object.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="unpacker"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Deserializing type is abstract type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.IMessagePackSerializer.UnpackTo(MsgPack.Unpacker,System.Object)">
|
|
<summary>
|
|
Deserialize collection items with specified <see cref="T:MsgPack.Unpacker"/> and stores them to <paramref name="collection"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree.</param>
|
|
<param name="collection">Collection that the items to be stored.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="unpacker"/> is <c>null</c>.
|
|
Or <paramref name="collection"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="collection"/> is not compatible for this serializer.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:System.NotSupportedException">
|
|
The type of <paramref name="collection"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.IMessagePackSingleObjectSerializer.PackSingleObject(System.Object)">
|
|
<summary>
|
|
Serialize specified object to the array of <see cref="T:System.Byte"/>.
|
|
</summary>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<returns>An array of <see cref="T:System.Byte"/> which stores serialized value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
<paramref name="objectTree"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.IMessagePackSingleObjectSerializer.UnpackSingleObject(System.Byte[])">
|
|
<summary>
|
|
Deserialize a single object from the array of <see cref="T:System.Byte"/> which contains a serialized object.
|
|
</summary>
|
|
<param name="buffer">An array of <see cref="T:System.Byte"/> serialized value to be stored.</param>
|
|
<returns>A bytes of serialized binary.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="buffer"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
This method assumes that <paramref name="buffer"/> contains single serialized object dedicatedly,
|
|
so this method does not return any information related to actual consumed bytes.
|
|
</para>
|
|
<para>
|
|
This method is a counter part of <see cref="M:MsgPack.Serialization.IMessagePackSingleObjectSerializer.PackSingleObject(System.Object)"/>.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> class with <see cref="T:PackerCompatibilityOptions.Classic"/>.
|
|
</summary>
|
|
<remarks>
|
|
This method supports backword compatibility with 0.3.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.#ctor(MsgPack.PackerCompatibilityOptions)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> class with default context..
|
|
</summary>
|
|
<param name="packerCompatibilityOptions">The <see cref="P:MsgPack.Serialization.MessagePackSerializer`1.PackerCompatibilityOptions"/> for new packer creation.</param>
|
|
<remarks>
|
|
This method supports backword compatibility with 0.4.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.#ctor(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> class.
|
|
</summary>
|
|
<param name="ownerContext">A <see cref="T:MsgPack.Serialization.SerializationContext"/> which owns this serializer.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="ownerContext"/> is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.#ctor(MsgPack.Serialization.SerializationContext,MsgPack.PackerCompatibilityOptions)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> class with explicitly specified compatibility option.
|
|
</summary>
|
|
<param name="ownerContext">A <see cref="T:MsgPack.Serialization.SerializationContext"/> which owns this serializer.</param>
|
|
<param name="packerCompatibilityOptions">The <see cref="P:MsgPack.Serialization.MessagePackSerializer`1.PackerCompatibilityOptions"/> for new packer creation.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="ownerContext"/> is <c>null</c>.</exception>
|
|
<remarks>
|
|
This method also supports backword compatibility with 0.4.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.Pack(System.IO.Stream,`0)">
|
|
<summary>
|
|
Serializes specified object to the <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="stream">Destination <see cref="T:System.IO.Stream"/>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="stream"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
<typeparamref name="T"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.Unpack(System.IO.Stream)">
|
|
<summary>
|
|
Deserialize object from the <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="stream">Source <see cref="T:System.IO.Stream"/>.</param>
|
|
<returns>Deserialized object.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="stream"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
<typeparamref name="T"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.PackTo(MsgPack.Packer,`0)">
|
|
<summary>
|
|
Serializes specified object with specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
<param name="packer"><see cref="T:MsgPack.Packer"/> which packs values in <paramref name="objectTree"/>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="packer"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
<typeparamref name="T"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)">
|
|
<summary>
|
|
Serializes specified object with specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
<param name="packer"><see cref="T:MsgPack.Packer"/> which packs values in <paramref name="objectTree"/>. This value will not be <c>null</c>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
<typeparamref name="T"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFrom(MsgPack.Unpacker)">
|
|
<summary>
|
|
Deserializes object with specified <see cref="T:MsgPack.Unpacker"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree.</param>
|
|
<returns>Deserialized object.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="unpacker"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:System.NotSupportedException">
|
|
<typeparamref name="T"/> is abstract type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)">
|
|
<summary>
|
|
Deserializes object with specified <see cref="T:MsgPack.Unpacker"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree. This value will not be <c>null</c>.</param>
|
|
<returns>Deserialized object.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:System.NotSupportedException">
|
|
<typeparamref name="T"/> is abstract type.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackTo(MsgPack.Unpacker,`0)">
|
|
<summary>
|
|
Deserializes collection items with specified <see cref="T:MsgPack.Unpacker"/> and stores them to <paramref name="collection"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree.</param>
|
|
<param name="collection">Collection that the items to be stored.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="unpacker"/> is <c>null</c>.
|
|
Or <paramref name="collection"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:System.NotSupportedException">
|
|
<typeparamref name="T"/> is not collection.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)">
|
|
<summary>
|
|
Deserializes collection items with specified <see cref="T:MsgPack.Unpacker"/> and stores them to <paramref name="collection"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree. This value will not be <c>null</c>.</param>
|
|
<param name="collection">Collection that the items to be stored. This value will not be <c>null</c>.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:System.NotSupportedException">
|
|
<typeparamref name="T"/> is not collection.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.PackSingleObject(`0)">
|
|
<summary>
|
|
Serializes specified object to the array of <see cref="T:System.Byte"/>.
|
|
</summary>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<returns>An array of <see cref="T:System.Byte"/> which stores serialized value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
<typeparamref name="T"/> is not serializable etc.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackSingleObject(System.Byte[])">
|
|
<summary>
|
|
Deserializes a single object from the array of <see cref="T:System.Byte"/> which contains a serialized object.
|
|
</summary>
|
|
<param name="buffer">An array of <see cref="T:System.Byte"/> serialized value to be stored.</param>
|
|
<returns>A bytes of serialized binary.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="buffer"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
This method assumes that <paramref name="buffer"/> contains single serialized object dedicatedly,
|
|
so this method does not return any information related to actual consumed bytes.
|
|
</para>
|
|
<para>
|
|
This method is a counter part of <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.PackSingleObject(`0)"/>.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.MessagePackSerializer`1.PackerCompatibilityOptions">
|
|
<summary>
|
|
Gets the packer compatibility options for this instance.
|
|
</summary>
|
|
<value>
|
|
The packer compatibility options for this instance
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.MessagePackSerializer`1.OwnerContext">
|
|
<summary>
|
|
Gets a <see cref="T:MsgPack.Serialization.SerializationContext"/> which owns this serializer.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:MsgPack.Serialization.SerializationContext"/> which owns this serializer.
|
|
</value>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AutoMessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)">
|
|
<summary>
|
|
Serialize specified object with specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
<param name="packer"><see cref="T:MsgPack.Packer"/> which packs values in <paramref name="objectTree"/>. This value will not be <c>null</c>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AutoMessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)">
|
|
<summary>
|
|
Deserialize object with specified <see cref="T:MsgPack.Unpacker"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree. This value will not be <c>null</c>.</param>
|
|
<returns>Deserialized object.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.AutoMessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)">
|
|
<summary>
|
|
Deserialize collection items with specified <see cref="T:MsgPack.Unpacker"/> and stores them to <paramref name="collection"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree. This value will not be <c>null</c>.</param>
|
|
<param name="collection">Collection that the items to be stored. This value will not be <c>null</c>.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:System.NotSupportedException">
|
|
<typeparamref name="T"/> is not collection.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.CallbackEnumMessagePackSerializer`1">
|
|
<summary>
|
|
Callback based <see cref="T:MsgPack.Serialization.EnumMessagePackSerializer`1"/> to implement context-based serialization.
|
|
</summary>
|
|
<typeparam name="TEnum">The type of target emum type.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EnumMessagePackSerializer`1">
|
|
<summary>
|
|
Defines basic features for enum object serializers.
|
|
</summary>
|
|
<typeparam name="TEnum">The type of enum type itself.</typeparam>
|
|
<remarks>
|
|
This class supports auto-detect on deserialization. So the constructor parameter only affects serialization behavior.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ICustomizableEnumSerializer">
|
|
<summary>
|
|
Represents customizable enum serializer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ICustomizableEnumSerializer.GetCopyAs(MsgPack.Serialization.EnumSerializationMethod)">
|
|
<summary>
|
|
Gets a copy with specified method.
|
|
</summary>
|
|
<param name="method">Enum serialization method.</param>
|
|
<returns>This instance or copied instance corresponds to the specified serialization method.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializer`1.#ctor(MsgPack.Serialization.SerializationContext,MsgPack.Serialization.EnumSerializationMethod)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EnumMessagePackSerializer`1"/> class.
|
|
</summary>
|
|
<param name="ownerContext">A <see cref="T:MsgPack.Serialization.SerializationContext"/> which owns this serializer.</param>
|
|
<param name="serializationMethod">The <see cref="T:MsgPack.Serialization.EnumSerializationMethod"/> which determines serialization form of the enums.</param>
|
|
<exception cref="T:System.InvalidOperationException"><c>TEnum</c> is not enum type.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)">
|
|
<summary>
|
|
Serializes specified object with specified <see cref="T:MsgPack.Packer"/>.
|
|
</summary>
|
|
<param name="packer"><see cref="T:MsgPack.Packer"/> which packs values in <paramref name="objectTree"/>. This value will not be <c>null</c>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializer`1.PackUnderlyingValueTo(MsgPack.Packer,`0)">
|
|
<summary>
|
|
Packs enum value as its underlying value.
|
|
</summary>
|
|
<param name="packer">The packer.</param>
|
|
<param name="enumValue">The enum value to be packed.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)">
|
|
<summary>
|
|
Deserializes object with specified <see cref="T:MsgPack.Unpacker"/>.
|
|
</summary>
|
|
<param name="unpacker"><see cref="T:MsgPack.Unpacker"/> which unpacks values of resulting object tree. This value will not be <c>null</c>.</param>
|
|
<returns>Deserialized object.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
<exception cref="T:MsgPack.InvalidMessagePackStreamException">
|
|
Failed to deserialize object due to invalid unpacker state, stream content, or so.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializer`1.UnpackFromUnderlyingValue(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Unpacks enum value from underlying integral value.
|
|
</summary>
|
|
<param name="messagePackObject">The message pack object which represents some integral value.</param>
|
|
<returns>
|
|
An enum value.
|
|
</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">The type of integral value is not compatible with underlying type of the enum.</exception>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.CallbackMessagePackSerializer`1">
|
|
<summary>
|
|
Callback based <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> to implement context-based serialization.
|
|
</summary>
|
|
<typeparam name="T">The type of target type.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DataMemberContract">
|
|
<summary>
|
|
Represents member's data contract.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.DataMemberContract.#ctor(System.Reflection.MemberInfo)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.DataMemberContract"/> struct.
|
|
</summary>
|
|
<param name="member">The target member.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.DataMemberContract.#ctor(System.Reflection.MemberInfo,System.String,MsgPack.Serialization.NilImplication,System.Nullable{System.Int32})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.DataMemberContract"/> struct.
|
|
</summary>
|
|
<param name="member">The target member.</param>
|
|
<param name="name">The name of member.</param>
|
|
<param name="nilImplication">The implication of the nil value for the member.</param>
|
|
<param name="id">The ID of the member. This value cannot be negative and must be unique in the type.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.DataMemberContract.#ctor(System.Reflection.MemberInfo,MsgPack.Serialization.MessagePackMemberAttribute)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.DataMemberContract"/> struct from <see cref="T:MsgPack.Serialization.MessagePackMemberAttribute"/>.
|
|
</summary>
|
|
<param name="member">The target member.</param>
|
|
<param name="attribute">The MessagePack member attribute.</param>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.DataMemberContract.Name">
|
|
<summary>
|
|
Gets the name of the member.
|
|
</summary>
|
|
<value>
|
|
The name of the member.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.DataMemberContract.Id">
|
|
<summary>
|
|
Gets the ID of the member.
|
|
</summary>
|
|
<value>
|
|
The ID of the member. Default is <c>-1</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.DataMemberContract.NilImplication">
|
|
<summary>
|
|
Gets the nil implication.
|
|
</summary>
|
|
<value>
|
|
The nil implication.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultConcreteTypeRepository">
|
|
<summary>
|
|
Repository of known concrete collection type for abstract collection type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.DefaultConcreteTypeRepository.Get(System.Type)">
|
|
<summary>
|
|
Gets the default type for the collection.
|
|
</summary>
|
|
<param name="abstractCollectionType">Type of the abstract collection.</param>
|
|
<returns>
|
|
Type of default concrete collection.
|
|
If concrete collection type of <paramref name="abstractCollectionType"/>, then returns <c>null</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="abstractCollectionType"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
By default, following types are registered:
|
|
<list type="table">
|
|
<listheader>
|
|
<term>Abstract Collection Type</term>
|
|
<description>Concrete Default Collection Type</description>
|
|
</listheader>
|
|
<item>
|
|
<term><see cref="T:System.Collections.Generic.IEnumerable`1"/></term>
|
|
<description><see cref="T:System.Collections.Generic.List`1"/></description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.Generic.ICollection`1"/></term>
|
|
<description><see cref="T:System.Collections.Generic.List`1"/></description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.Generic.ISet`1"/> (.NET 4 or lator)</term>
|
|
<description><see cref="T:System.Collections.Generic.HashSet`1"/></description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.Generic.IList`1"/></term>
|
|
<description><see cref="T:System.Collections.Generic.List`1"/></description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.Generic.IDictionary`2"/></term>
|
|
<description><see cref="T:System.Collections.Generic.Dictionary`2"/></description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.IEnumerable"/></term>
|
|
<description><see cref="T:System.Collections.Generic.List`1"/> of <see cref="T:MsgPack.MessagePackObject"/>.</description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.ICollection"/></term>
|
|
<description><see cref="T:System.Collections.Generic.List`1"/> of <see cref="T:MsgPack.MessagePackObject"/>.</description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.IList"/></term>
|
|
<description><see cref="T:System.Collections.Generic.List`1"/> of <see cref="T:MsgPack.MessagePackObject"/>.</description>
|
|
</item>
|
|
<item>
|
|
<term><see cref="T:System.Collections.IDictionary"/></term>
|
|
<description><see cref="T:MsgPack.MessagePackObjectDictionary"/></description>
|
|
</item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.DefaultConcreteTypeRepository.Register(System.Type,System.Type)">
|
|
<summary>
|
|
Registers the default type of the collection.
|
|
</summary>
|
|
<param name="abstractCollectionType">Type of the abstract collection.</param>
|
|
<param name="defaultCollectionType">Default concrete type of the <paramref name="abstractCollectionType"/>.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="abstractCollectionType"/> is <c>null</c>.
|
|
Or <paramref name="defaultCollectionType"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="abstractCollectionType"/> is not collection type.
|
|
Or <paramref name="defaultCollectionType"/> is abstract class or interface.
|
|
Or <paramref name="defaultCollectionType"/> is open generic type but <paramref name="abstractCollectionType"/> is closed generic type.
|
|
Or <paramref name="defaultCollectionType"/> is closed generic type but <paramref name="abstractCollectionType"/> is open generic type.
|
|
Or <paramref name="defaultCollectionType"/> does not have same arity for <paramref name="abstractCollectionType"/>.
|
|
Or <paramref name="defaultCollectionType"/> is not assignable to <paramref name="abstractCollectionType"/>
|
|
or the constructed type from <paramref name="defaultCollectionType"/> will not be assignable to the constructed type from <paramref name="abstractCollectionType"/>.
|
|
</exception>
|
|
<remarks>
|
|
If you want to overwrite default type for collection interfaces, you can use this method.
|
|
Note that this method only supports collection interface, that is subtype of the <see cref="T:System.Collections.IEnumerable"/> interface.
|
|
<note>
|
|
If you register invalid type for <paramref name="defaultCollectionType"/>, then runtime exception will be occurred.
|
|
For example, you register <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Char"/> and <see cref="T:System.String"/> pair, but it will cause runtime error.
|
|
</note>
|
|
</remarks>
|
|
<seealso cref="M:MsgPack.Serialization.DefaultConcreteTypeRepository.Get(System.Type)"/>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.DefaultConcreteTypeRepository.Unregister(System.Type)">
|
|
<summary>
|
|
Unregisters the default type of the collection.
|
|
</summary>
|
|
<param name="abstractCollectionType">Type of the abstract collection.</param>
|
|
<returns>
|
|
<c>true</c> if default collection type is removed successfully;
|
|
otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.CollectionSerializer`1">
|
|
<summary>
|
|
Collection interface serializer.
|
|
</summary>
|
|
<typeparam name="T">The type of the item of collection.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.EnumerableSerializerBase`2">
|
|
<summary>
|
|
Provides basic features for non-dictionary generic collection serializers.
|
|
</summary>
|
|
<typeparam name="T">The type of the collection.</typeparam>
|
|
<typeparam name="TItem">The type of the item of the collection.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.DictionarySerializer`2">
|
|
<summary>
|
|
Dictionary interface serializer.
|
|
</summary>
|
|
<typeparam name="TKey">The type of the key of dictionary.</typeparam>
|
|
<typeparam name="TValue">The type of the value of dictionary.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.EnumerableSerializer`1">
|
|
<summary>
|
|
Enumerable interface serializer.
|
|
</summary>
|
|
<typeparam name="T">The type of the item of collection.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.GenericSerializer">
|
|
<summary>
|
|
Defines serializer factory for well known structured types.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.GenericSerializer.IInstanceFactory">
|
|
<summary>
|
|
Defines non-generic factory method.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.ListSerializer`1">
|
|
<summary>
|
|
List interface serializer.
|
|
</summary>
|
|
<typeparam name="T">The type of the item of collection.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.DefaultSerializers.MessagePackObjectExtensions.DeserializeAsString(MsgPack.MessagePackObject)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.MessagePackObject.AsString"/> in deserializaton manner.
|
|
</summary>
|
|
<param name="source"><see cref="T:MsgPack.MessagePackObject"/>.</param>
|
|
<returns>A deserialized value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException"><paramref name="source"/> is not expected type.</exception>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.NonGenericCollectionSerializer">
|
|
<summary>
|
|
Non generic collection interface serializer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.NonGenericEnumerableSerializerBase`1">
|
|
<summary>
|
|
Provides basic features for non dictionary, non-generic collection interface serializers.
|
|
</summary>
|
|
<typeparam name="T">The type of the item of collection.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.NonGenericDictionarySerializer">
|
|
<summary>
|
|
Dictionary interface serializer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.NonGenericEnumerableSerializer">
|
|
<summary>
|
|
Non generic enumerable interface serializer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.NonGenericListSerializer">
|
|
<summary>
|
|
Non generic list interface serializer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.System_Collections_Generic_Dictionary_2MessagePackSerializer`2">
|
|
<summary>
|
|
Provides default implementation for <see cref="T:System.Collections.Generic.Dictionary`2"/>.
|
|
</summary>
|
|
<typeparam name="TKey">The type of keys of the <see cref="T:System.Collections.Generic.Dictionary`2"/>.</typeparam>
|
|
<typeparam name="TValue">The type of values of the <see cref="T:System.Collections.Generic.Dictionary`2"/>.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.DefaultSerializers.System_Collections_Generic_List_1MessagePackSerializer`1">
|
|
<summary>
|
|
Provides default implementation for <see cref="T:System.Collections.Generic.List`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of items of the <see cref="T:System.Collections.Generic.List`1"/>.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmitterFlavor">
|
|
<summary>
|
|
Determines emitter strategy.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EmitterFlavor.ContextBased">
|
|
<summary>
|
|
Uses <see cref="T:MsgPack.Serialization.SerializationContext"/> in each case of the members (de)serialization.
|
|
It may cause more contentions but is available in WP7.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EmitterFlavor.FieldBased">
|
|
<summary>
|
|
Caches serializers for the members (de)serialization.
|
|
It is default.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EmitterFlavor.ExpressionBased">
|
|
<summary>
|
|
Uses expression tree to (de)serialization.
|
|
It may have more overhead but is available in WinRT.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EmitterFlavor.CodeDomBased">
|
|
<summary>
|
|
Uses code DOM code generation to (de)serialization.
|
|
It requires a long time but prevents runtime code generation at all.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EmitterFlavor.ReflectionBased">
|
|
<summary>
|
|
Uses reflection to (de)serialization.
|
|
It requires additional resources but may work on most environment.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.ILConstruct">
|
|
<summary>
|
|
Represents code construct for <see cref="T:MsgPack.Serialization.EmittingSerializers.ILEmittingSerializerBuilder`2"/>s.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILConstruct.#ctor(System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.ILConstruct"/> class.
|
|
</summary>
|
|
<param name="contextType">The type.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILConstruct.Evaluate(MsgPack.Serialization.Reflection.TracingILGenerator)">
|
|
<summary>
|
|
Evaluates this construct that is executing this construct as instruction.
|
|
</summary>
|
|
<param name="il">The <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/>.</param>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
This construct does not have eval semantics.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILConstruct.LoadValue(MsgPack.Serialization.Reflection.TracingILGenerator,System.Boolean)">
|
|
<summary>
|
|
Loads value from the storage represented by this construct.
|
|
</summary>
|
|
<param name="il">The <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/>.</param>
|
|
<param name="shouldBeAddress">
|
|
<c>true</c>, if value type value should be pushed its address instead of bits; otherwise, <c>false</c>.
|
|
</param>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
This construct does not have load value semantics.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILConstruct.StoreValue(MsgPack.Serialization.Reflection.TracingILGenerator)">
|
|
<summary>
|
|
Stores value to the storage represented by this construct.
|
|
</summary>
|
|
<param name="il">The <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/>.</param>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
This construct does not have store value semantics.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILConstruct.Branch(MsgPack.Serialization.Reflection.TracingILGenerator,System.Reflection.Emit.Label)">
|
|
<summary>
|
|
Evaluates this construct as branch instruction.
|
|
</summary>
|
|
<param name="il">The <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/>.</param>
|
|
<param name="else">The <see cref="T:System.Reflection.Emit.Label"/> which points the head of 'else' instructions.</param>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
This construct does not have branch semantics.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.EmittingSerializers.ILConstruct.ContextType">
|
|
<summary>
|
|
Gets the context type of this construct.
|
|
</summary>
|
|
<value>
|
|
The context type of this construct.
|
|
This value will not be <c>null</c>, but might be <see cref="T:System.Void"/>.
|
|
</value>
|
|
<remarks>
|
|
A context type represents the type of the evaluation context.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.EmittingSerializers.ILConstruct.IsTerminating">
|
|
<summary>
|
|
Gets a value indicating whether this instance is terminating.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instruction terminates method; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.AssemblyBuilderEmittingContext">
|
|
<summary>
|
|
A code generation context for <see cref="T:MsgPack.Serialization.EmittingSerializers.AssemblyBuilderSerializerBuilder`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.ILEmittingContext">
|
|
<summary>
|
|
Implements <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1"/> for <see cref="T:MsgPack.Serialization.EmittingSerializers.ILEmittingSerializerBuilder`2"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILEmittingContext.GetSerializerType(System.Type)">
|
|
<summary>
|
|
Gets the type of the serializer.
|
|
</summary>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
<returns>Type of the serializer.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILEmittingContext.#ctor(MsgPack.Serialization.SerializationContext,System.Func{MsgPack.Serialization.EmittingSerializers.SerializerEmitter},System.Func{MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.ILEmittingContext"/> class.
|
|
</summary>
|
|
<param name="context">The serialization context.</param>
|
|
<param name="emitterFactory">
|
|
The factory for <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> to be used.
|
|
</param>
|
|
<param name="enumEmitterFactory">
|
|
The factory for <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/> to be used.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILEmittingContext.ResetCore(System.Type)">
|
|
<summary>
|
|
Resets internal states for specified target type.
|
|
</summary>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.EmittingSerializers.ILEmittingContext.IL">
|
|
<summary>
|
|
Gets or sets the <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> to emit IL for current method.
|
|
</summary>
|
|
<value>
|
|
The <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> to emit IL for current method.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.EmittingSerializers.ILEmittingContext.Emitter">
|
|
<summary>
|
|
Gets the <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/>.
|
|
</summary>
|
|
<value>
|
|
The <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.EmittingSerializers.ILEmittingContext.EnumEmitter">
|
|
<summary>
|
|
Gets the <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/>.
|
|
</summary>
|
|
<value>
|
|
The <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/>.
|
|
</value>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.AssemblyBuilderEmittingContext.#ctor(MsgPack.Serialization.SerializationContext,System.Type,System.Func{MsgPack.Serialization.EmittingSerializers.SerializerEmitter},System.Func{MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.AssemblyBuilderEmittingContext"/> class.
|
|
</summary>
|
|
<param name="context">The serialization context.</param>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
<param name="emitterFactory">
|
|
The factory for <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> to be used.
|
|
</param>
|
|
<param name="enumEmitterFactory">
|
|
The factory for <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/> to be used.
|
|
</param>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.AssemblyBuilderSerializerBuilder`1">
|
|
<summary>
|
|
An implementation of <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3"/> with <see cref="T:System.Reflection.Emit.AssemblyBuilder"/>.
|
|
</summary>
|
|
<typeparam name="TObject">The type of the serializing object.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.ILEmittingSerializerBuilder`2">
|
|
<summary>
|
|
Implements common features for IL emitter based serializer builders.
|
|
</summary>
|
|
<typeparam name="TContext">The type of the code generation context.</typeparam>
|
|
<typeparam name="TObject">The type of the serialization target object.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ILEmittingSerializerBuilder`2.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.ILEmittingSerializerBuilder`2"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.AssemblyBuilderSerializerBuilder`1.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.AssemblyBuilderSerializerBuilder`1"/> class for instance creation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter">
|
|
<summary>
|
|
Genereates enum serialization methods which can be save to file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter.Dispose">
|
|
<summary>
|
|
Releases all managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and optionally managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter.GetPackUnderyingValueToMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.EnumMessagePackSerializer`1.PackUnderlyingValueTo(MsgPack.Packer,`0)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.EnumMessagePackSerializer`1.PackUnderlyingValueTo(MsgPack.Packer,`0)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter.GetUnpackFromUnderlyingValueMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.EnumMessagePackSerializer`1.UnpackFromUnderlyingValue(MsgPack.MessagePackObject)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.EnumMessagePackSerializer`1.UnpackFromUnderlyingValue(MsgPack.MessagePackObject)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter.CreateInstance``1(MsgPack.Serialization.SerializationContext,MsgPack.Serialization.EnumSerializationMethod)">
|
|
<summary>
|
|
Creates the serializer type built now and returns its new instance.
|
|
</summary>
|
|
<typeparam name="T">Target type to be serialized/deserialized.</typeparam>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> to holds serializers.</param>
|
|
<param name="serializationMethod">The <see cref="T:MsgPack.Serialization.EnumSerializationMethod"/> which determines serialization form of the enums.</param>
|
|
<returns>
|
|
Newly built <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter.CreateConstructor``1">
|
|
<summary>
|
|
Creates instance constructor delegates.
|
|
</summary>
|
|
<typeparam name="T">Target type to be serialized/deserialized.</typeparam>
|
|
<returns>A delegate for serializer constructor.</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter">
|
|
<summary>
|
|
<see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> using <see cref="T:MsgPack.Serialization.SerializationContext"/> to hold serializers for target members.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter">
|
|
<summary>
|
|
Genereates serialization methods which can be save to file.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.Dispose">
|
|
<summary>
|
|
Releases all managed resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases unmanaged and optionally managed resources.
|
|
</summary>
|
|
<param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.GetPackToMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.GetUnpackFromMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.GetUnpackToMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)"/> overrides.
|
|
</returns>
|
|
<remarks>
|
|
When this method is called, <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)"/> will be overridden.
|
|
This value will not be <c>null</c>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.CreateInstance``1(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Creates the serializer type built now and returns its new instance.
|
|
</summary>
|
|
<typeparam name="T">Target type to be serialized/deserialized.</typeparam>
|
|
<param name="context">The <see cref="T:MsgPack.Serialization.SerializationContext"/> to holds serializers.</param>
|
|
<returns>
|
|
Newly built <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.CreateConstructor``1">
|
|
<summary>
|
|
Creates instance constructor delegates.
|
|
</summary>
|
|
<typeparam name="T">Target type to be serialized/deserialized.</typeparam>
|
|
<returns>A delegate for serializer constructor.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.RegisterSerializer(System.Type,MsgPack.Serialization.EnumMemberSerializationMethod)">
|
|
<summary>
|
|
Regisgters <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> of target type usage to the current emitting session.
|
|
</summary>
|
|
<param name="targetType">The type of the member to be serialized/deserialized.</param>
|
|
<param name="enumMemberSerializationMethod">The enum serialization method of the member to be serialized/deserialized.</param>
|
|
<returns>
|
|
<see cref="T:System.Action`2"/> to emit serializer retrieval instructions.
|
|
The 1st argument should be <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> to emit instructions.
|
|
The 2nd argument should be argument index of the serializer holder, normally 0 (this pointer).
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.RegisterField(System.Reflection.FieldInfo)">
|
|
<summary>
|
|
Regisgters <see cref="T:System.Reflection.FieldInfo"/> usage to the current emitting session.
|
|
</summary>
|
|
<param name="field">The <see cref="T:System.Reflection.FieldInfo"/> to be registered.</param>
|
|
<returns>
|
|
<see cref="T:System.Action`2"/> to emit serializer retrieval instructions.
|
|
The 1st argument should be <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> to emit instructions.
|
|
The 2nd argument should be argument index of the serializer holder, normally 0 (this pointer).
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializerEmitter.RegisterMethod(System.Reflection.MethodBase)">
|
|
<summary>
|
|
Regisgters <see cref="T:System.Reflection.MethodBase"/> usage to the current emitting session.
|
|
</summary>
|
|
<param name="method">The <see cref="T:System.Reflection.MethodBase"/> to be registered.</param>
|
|
<returns>
|
|
<see cref="T:System.Action`2"/> to emit serializer retrieval instructions.
|
|
The 1st argument should be <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> to emit instructions.
|
|
The 2nd argument should be argument index of the serializer holder, normally 0 (this pointer).
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter.#ctor(System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter"/> class.
|
|
</summary>
|
|
<param name="targetType">Type of the target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter.GetPackToMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter.GetUnpackFromMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter.GetUnpackToMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)"/> overrides.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter.CreateConstructor``1">
|
|
<summary>
|
|
Creates the serializer type built now and returns its constructor.
|
|
</summary>
|
|
<typeparam name="T">The type of serialization target.</typeparam>
|
|
<returns>
|
|
Newly built <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> type constructor.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.ContextBasedSerializerEmitter.RegisterSerializer(System.Type,MsgPack.Serialization.EnumMemberSerializationMethod)">
|
|
<summary>
|
|
Regisgter using <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> target type to the current emitting session.
|
|
</summary>
|
|
<param name="targetType">The type of the member to be serialized/deserialized.</param>
|
|
<param name="enumMemberSerializationMethod">The enum serialization method of the member to be serialized/deserialized.</param>
|
|
<returns>
|
|
<see cref="T:System.Action`2"/> to emit serializer retrieval instructions.
|
|
The 1st argument should be <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> to emit instructions.
|
|
The 2nd argument should be argument index of the serializer holder.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.DefaultSerializationMethodGeneratorManager">
|
|
<summary>
|
|
Manages serializer generators.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager">
|
|
<summary>
|
|
Defines common features and interfaces for <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager.Get">
|
|
<summary>
|
|
Get the appropriate <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager"/> for the current configuration.
|
|
</summary>
|
|
<returns>
|
|
The appropriate <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager"/> for the current configuration.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager.Get(MsgPack.Serialization.SerializationMethodGeneratorOption)">
|
|
<summary>
|
|
Get the appropriate <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager"/> for specified options.
|
|
</summary>
|
|
<param name="option"><see cref="T:MsgPack.Serialization.SerializationMethodGeneratorOption"/>.</param>
|
|
<returns>
|
|
The appropriate <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager"/> for specified options.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager.CreateEmitter(System.Type,MsgPack.Serialization.EmitterFlavor)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.
|
|
</summary>
|
|
<param name="targetType">The type of the serialization target.</param>
|
|
<param name="emitterFlavor"><see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</param>
|
|
<returns>New <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager.CreateEmitterCore(System.Type,MsgPack.Serialization.EmitterFlavor)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.
|
|
</summary>
|
|
<param name="targetType">The type of the serialization target.</param>
|
|
<param name="emitterFlavor"><see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</param>
|
|
<returns>New <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager.CreateEnumEmitter(System.Type,MsgPack.Serialization.EmitterFlavor)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.
|
|
</summary>
|
|
<param name="targetType">The type of the serialization target.</param>
|
|
<param name="emitterFlavor"><see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</param>
|
|
<returns>New <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.SerializationMethodGeneratorManager.CreateEnumEmitterCore(System.Type,MsgPack.Serialization.EmitterFlavor)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.
|
|
</summary>
|
|
<param name="targetType">The type of the serialization target.</param>
|
|
<param name="emitterFlavor"><see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</param>
|
|
<returns>New <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.DefaultSerializationMethodGeneratorManager.CreateEmitterCore(System.Type,MsgPack.Serialization.EmitterFlavor)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.
|
|
</summary>
|
|
<param name="targetType">The type of the serialization target.</param>
|
|
<param name="emitterFlavor"><see cref="T:MsgPack.Serialization.EmitterFlavor"/>.</param>
|
|
<returns>
|
|
New <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> which corresponds to the specified <see cref="T:MsgPack.Serialization.EmitterFlavor"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.EmittingSerializers.DefaultSerializationMethodGeneratorManager.Fast">
|
|
<summary>
|
|
Get the singleton instance for fast mode.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.DynamicMethodEmittingContext">
|
|
<summary>
|
|
Implements <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1"/> for <see cref="T:MsgPack.Serialization.EmittingSerializers.DynamicMethodSerializerBuilder`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.DynamicMethodEmittingContext.#ctor(MsgPack.Serialization.SerializationContext,System.Type,System.Func{MsgPack.Serialization.EmittingSerializers.SerializerEmitter},System.Func{MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.DynamicMethodEmittingContext"/> class.
|
|
</summary>
|
|
<param name="context">The serialization context.</param>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
<param name="emitterFactory">
|
|
The factory for <see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> to be used.
|
|
</param>
|
|
<param name="enumEmitterFactory">
|
|
The factory for <see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/> to be used.
|
|
</param>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.EmittingSerializers.DynamicMethodEmittingContext.Context">
|
|
<summary>
|
|
Gets the code construct which represents 'context' parameter of generated methods.
|
|
</summary>
|
|
<value>
|
|
The code construct which represents 'context' parameter of generated methods.
|
|
Its type is <see cref="T:MsgPack.Serialization.SerializationContext"/>, and it holds dependent serializers.
|
|
This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.DynamicMethodSerializerBuilder`1">
|
|
<summary>
|
|
An implementation of <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3"/> using dynamic methods.
|
|
</summary>
|
|
<typeparam name="TObject">The type of the serializing object.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.DynamicMethodSerializerBuilder`1.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.DynamicMethodSerializerBuilder`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.FieldBasedEnumSerializerEmitter">
|
|
<summary>
|
|
<see cref="T:MsgPack.Serialization.EmittingSerializers.EnumSerializerEmitter"/> using instance fields to hold serializers for target members.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.FieldBasedEnumSerializerEmitter.#ctor(System.Reflection.Emit.ModuleBuilder,System.Nullable{System.Int32},System.Type,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter"/> class.
|
|
</summary>
|
|
<param name="host">The host <see cref="T:System.Reflection.Emit.ModuleBuilder"/>.</param>
|
|
<param name="sequence">The sequence number to name new type.</param>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
<param name="isDebuggable">Set to <c>true</c> when <paramref name="host"/> is debuggable.</param>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter">
|
|
<summary>
|
|
<see cref="T:MsgPack.Serialization.EmittingSerializers.SerializerEmitter"/> using instance fields to hold serializers for target members.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter.#ctor(System.Reflection.Emit.ModuleBuilder,System.Nullable{System.Int32},System.Type,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter"/> class.
|
|
</summary>
|
|
<param name="host">The host <see cref="T:System.Reflection.Emit.ModuleBuilder"/>.</param>
|
|
<param name="sequence">The sequence number to name new type.</param>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
<param name="isDebuggable">Set to <c>true</c> when <paramref name="host"/> is debuggable.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter.GetPackToMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.PackToCore(MsgPack.Packer,`0)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter.GetUnpackFromMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)"/> overrides.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter.GetUnpackToMethodILGenerator">
|
|
<summary>
|
|
Gets the IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)"/> overrides.
|
|
</summary>
|
|
<returns>
|
|
The IL generator to implement <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackToCore(MsgPack.Unpacker,`0)"/> overrides.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter.CreateConstructor``1">
|
|
<summary>
|
|
Creates the serializer type built now and returns its constructor.
|
|
</summary>
|
|
<typeparam name="T">The type of serialization target.</typeparam>
|
|
<returns>
|
|
Newly built <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> type constructor.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EmittingSerializers.FieldBasedSerializerEmitter.RegisterSerializer(System.Type,MsgPack.Serialization.EnumMemberSerializationMethod)">
|
|
<summary>
|
|
Regisgter using <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> target type to the current emitting session.
|
|
</summary>
|
|
<param name="targetType">The type of the member to be serialized/deserialized.</param>
|
|
<param name="enumMemberSerializationMethod">The enum serialization method of the member to be serialized/deserialized.</param>
|
|
<returns>
|
|
<see cref="T:System.Action`2"/> to emit serializer retrieval instructions.
|
|
The 1st argument should be <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> to emit instructions.
|
|
The 2nd argument should be argument index of the serializer holder.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EnumMemberSerializationMethod">
|
|
<summary>
|
|
Represents individual enum typed member serialization method.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EnumMemberSerializationMethod.Default">
|
|
<summary>
|
|
Respects setting in enum type itself or system default.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EnumMemberSerializationMethod.ByName">
|
|
<summary>
|
|
Enums are serialized with their name. It is more torelant to versioning but less efficient.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EnumMemberSerializationMethod.ByUnderlyingValue">
|
|
<summary>
|
|
Enums are serialized with their underlying value. It is more efficient but less torelant to versioning.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EnumMessagePackSerializerHelpers">
|
|
<summary>
|
|
<strong>This is intened to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Helper methods for enum message pack serializer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializerHelpers.DetermineEnumSerializationMethod(MsgPack.Serialization.SerializationContext,System.Type,MsgPack.Serialization.EnumMemberSerializationMethod)">
|
|
<summary>
|
|
Determines <see cref="T:MsgPack.Serialization.EnumSerializationMethod"/> for the target.
|
|
</summary>
|
|
<param name="context">Context information.</param>
|
|
<param name="enumType">The target enum type.</param>
|
|
<param name="enumMemberSerializationMethod">The method argued by the member.</param>
|
|
<returns>Determined <see cref="T:MsgPack.Serialization.EnumSerializationMethod"/> for the target.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="context"/> is <c>null</c>.
|
|
Or <paramref name="enumType"/> is <c>null</c>.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EnumMessagePackSerializerProvider">
|
|
<summary>
|
|
Implements <see cref="T:MsgPack.Serialization.MessagePackSerializerProvider"/> for enums.
|
|
This class accepts <see cref="T:MsgPack.Serialization.EnumSerializationMethod"/> as a provider parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.MessagePackSerializerProvider">
|
|
<summary>
|
|
Defines basic features and interfaces for serializer provider which is stored in repository and controlls returning serializer with its own parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializerProvider.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackSerializerProvider"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializerProvider.Get(MsgPack.Serialization.SerializationContext,System.Object)">
|
|
<summary>
|
|
Gets a serializer instance for specified parameter.
|
|
</summary>
|
|
<param name="context">A serialization context which holds global settings.</param>
|
|
<param name="providerParameter">A provider specific parameter.</param>
|
|
<returns>A serializer object for specified parameter.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializerProvider.#ctor(System.Type,MsgPack.Serialization.ICustomizableEnumSerializer)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.EnumMessagePackSerializerProvider"/> class.
|
|
</summary>
|
|
<param name="enumType">A type of the enum.</param>
|
|
<param name="serializer">The serializer implements <see cref="T:MsgPack.Serialization.ICustomizableEnumSerializer"/>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.EnumMessagePackSerializerProvider.Get(MsgPack.Serialization.SerializationContext,System.Object)">
|
|
<summary>
|
|
Gets a serializer instance for specified parameter.
|
|
</summary>
|
|
<param name="context">A serialization context which holds global settings.</param>
|
|
<param name="providerParameter">A provider specific parameter.</param>
|
|
<returns>
|
|
A serializer object for specified parameter.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.EnumSerializationMethod">
|
|
<summary>
|
|
Represents enum type serialization method.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EnumSerializationMethod.ByName">
|
|
<summary>
|
|
Enums are serialized with their name. It is more torelant to versioning but less efficient.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.EnumSerializationMethod.ByUnderlyingValue">
|
|
<summary>
|
|
Enums are serialized with their underlying value. It is more efficient but less torelant to versioning.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackEnumMessagePackSerializer`1">
|
|
<summary>
|
|
A helper <see cref="T:MsgPack.Serialization.EnumMessagePackSerializer`1"/> for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeSerializerBuilder`1"/>.
|
|
</summary>
|
|
<typeparam name="TEnum">The type of the serialization target.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer`1">
|
|
<summary>
|
|
A helper <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeSerializerBuilder`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of the serialization target.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer`1.#ctor(MsgPack.Serialization.SerializationContext,System.Action{MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer{`0},MsgPack.Serialization.SerializationContext,MsgPack.Packer,`0},System.Func{MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer{`0},MsgPack.Serialization.SerializationContext,MsgPack.Unpacker,`0},System.Action{MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer{`0},MsgPack.Serialization.SerializationContext,MsgPack.Unpacker,`0})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer`1"/> class.
|
|
</summary>
|
|
<param name="ownerContext">The serialization context.</param>
|
|
<param name="packToCore">The delegate to <c>PackToCore</c> method body. This value must not be <c>null</c>.</param>
|
|
<param name="unpackFromCore">The delegate to <c>UnpackFromCore</c> method body. This value must not be <c>null</c>.</param>
|
|
<param name="unpackToCore">The delegate to <c>UnpackToCore</c> method body. This value can be <c>null</c>.</param>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct">
|
|
<summary>
|
|
Represents a code construct for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeSerializerBuilder`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.#ctor(System.Linq.Expressions.Expression)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct"/> class, not significant reference.
|
|
</summary>
|
|
<param name="expression">The <see cref="T:System.Linq.Expressions.Expression"/>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.#ctor(System.Linq.Expressions.Expression,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct"/> class.
|
|
</summary>
|
|
<param name="expression">The <see cref="T:System.Linq.Expressions.Expression"/>.</param>
|
|
<param name="isSignificantReference">
|
|
<c>true</c> if this instance is significant reference; otherwise, <c>false</c>.
|
|
</param>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.Expression">
|
|
<summary>
|
|
Gets the <see cref="P:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.Expression"/> for this construct.
|
|
</summary>
|
|
<value>
|
|
The <see cref="P:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.Expression"/> for this construct.
|
|
This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.IsSignificantReference">
|
|
<summary>
|
|
Gets a value indicating whether this instance is significant reference.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if this instance is significant reference; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
'Significant' reference should be appeared in block expression to represent single parameter/variable reference.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.ContextType">
|
|
<summary>
|
|
Gets the context type of this construct.
|
|
</summary>
|
|
<value>
|
|
The context type of this construct.
|
|
This value will not be <c>null</c>, but might be <see cref="T:System.Void"/>.
|
|
</value>
|
|
<remarks>
|
|
This property wraps <see cref="P:System.Linq.Expressions.Expression.Type"/> property for <see cref="P:MsgPack.Serialization.ExpressionSerializers.ExpressionConstruct.Expression"/> property.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ExpressionSerializers.ExpressionDumper">
|
|
<summary>
|
|
Takes text dump for expression tree supporting block expression etc.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext">
|
|
<summary>
|
|
Implements <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerGenerationContext`1"/> for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeSerializerBuilder`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.#ctor(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext"/> class.
|
|
</summary>
|
|
<param name="context">The serialization context.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.CreateDelegateType``1(MsgPack.Serialization.AbstractSerializers.SerializerMethod)">
|
|
<summary>
|
|
Creates the type of the delegate.
|
|
</summary>
|
|
<typeparam name="TObject">The type of serialization target.</typeparam>
|
|
<param name="method">The method to be created.</param>
|
|
<returns>
|
|
The <see cref="T:System.Type"/> of delegate which can refer to the generating method.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
<paramref name="method"/> is unknown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.CreateDelegateType``1(MsgPack.Serialization.AbstractSerializers.EnumSerializerMethod)">
|
|
<summary>
|
|
Creates the type of the delegate.
|
|
</summary>
|
|
<typeparam name="TObject">The type of serialization target.</typeparam>
|
|
<param name="method">The method to be created.</param>
|
|
<returns>
|
|
The <see cref="T:System.Type"/> of delegate which can refer to the generating method.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
<exception cref="T:System.InvalidOperationException">
|
|
<paramref name="method"/> is unknown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.GetParameters(MsgPack.Serialization.AbstractSerializers.SerializerMethod)">
|
|
<summary>
|
|
Gets the <see cref="T:System.Linq.Expressions.ParameterExpression"/>s for specified method.
|
|
</summary>
|
|
<param name="method">The method to be created.</param>
|
|
<returns>
|
|
The <see cref="T:System.Linq.Expressions.ParameterExpression"/>s for specified method.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.GetParameters(System.Type,MsgPack.Serialization.AbstractSerializers.EnumSerializerMethod)">
|
|
<summary>
|
|
Gets the <see cref="T:System.Linq.Expressions.ParameterExpression"/>s for specified method.
|
|
</summary>
|
|
<param name="targetType">The type of the serialization target.</param>
|
|
<param name="method">The method to be created.</param>
|
|
<returns>
|
|
The <see cref="T:System.Linq.Expressions.ParameterExpression"/>s for specified method.
|
|
This value will not be <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.SetDelegate(MsgPack.Serialization.AbstractSerializers.SerializerMethod,System.Delegate)">
|
|
<summary>
|
|
Sets the specified delegate object for specified method.
|
|
</summary>
|
|
<param name="method">The method to be created.</param>
|
|
<param name="delegate">The delegate which refers the generated method.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.SetDelegate(MsgPack.Serialization.AbstractSerializers.EnumSerializerMethod,System.Delegate)">
|
|
<summary>
|
|
Sets the specified delegate object for specified method.
|
|
</summary>
|
|
<param name="method">The method to be created.</param>
|
|
<param name="delegate">The delegate which refers the generated method.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.GetPackToCore``1">
|
|
<summary>
|
|
Gets the delegate which refers created <c>PackToCore(SerializationContext,Packer,T)</c> instance method for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of serialization target.</typeparam>
|
|
<returns>
|
|
The delegate which was set for <c>PackToCore</c> method.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.GetUnpackFromCore``1">
|
|
<summary>
|
|
Gets the delegate which refers created <c>UnpackFromCore(SerializationContext,Unpacker)</c> instance method for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of deserialization target.</typeparam>
|
|
<returns>
|
|
The delegate which was set for <c>UnpackFromCore</c> method.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.GetUnpackToCore``1">
|
|
<summary>
|
|
Gets the delegate which refers created <c>UnpackToCore(SerializationContext,Unpacker,T)</c> instance method for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackMessagePackSerializer`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of deserialization target.</typeparam>
|
|
<returns>
|
|
The delegate which was set for <c>UnpackToCore</c> method.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.GetPackUnderyingValueTo``1">
|
|
<summary>
|
|
Gets the delegate which refers created <c>PackUnderlyingValueTo(Packer,T)</c> instance method for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackEnumMessagePackSerializer`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of deserialization target.</typeparam>
|
|
<returns>
|
|
The delegate which was set for <c>UnpackToCore</c> method.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.GetUnpackFromUnderlyingValue``1">
|
|
<summary>
|
|
Gets the delegate which refers created <c>UnpackFromUnderlyingValue(MessagePackObject)</c> instance method for <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionCallbackEnumMessagePackSerializer`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of deserialization target.</typeparam>
|
|
<returns>
|
|
The delegate which was set for <c>UnpackFromCore</c> method.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.Context">
|
|
<summary>
|
|
Gets the code construct which represents 'context' parameter of generated methods.
|
|
</summary>
|
|
<value>
|
|
The code construct which represents 'context' parameter of generated methods.
|
|
Its type is <see cref="T:MsgPack.Serialization.SerializationContext"/>, and it holds dependent serializers.
|
|
This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeContext.This">
|
|
<summary>
|
|
Gets the code construct which represents 'this' reference.
|
|
</summary>
|
|
<value>
|
|
The code construct which represents 'this' reference.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeSerializerBuilder`1">
|
|
<summary>
|
|
An implementation of <see cref="T:MsgPack.Serialization.AbstractSerializers.SerializerBuilder`3"/> using expression tree.
|
|
</summary>
|
|
<typeparam name="TObject">The type of the serializing object.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeSerializerBuilder`1.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.ExpressionSerializers.ExpressionTreeSerializerBuilder`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.IdentifierUtility">
|
|
<summary>
|
|
Utilities related to member/type ID.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.LazyDelegatingMessagePackSerializer`1">
|
|
<summary>
|
|
Lazy initialized serializer which delegates actual work for the other serializer implementation.
|
|
</summary>
|
|
<typeparam name="T">
|
|
The type of target type.
|
|
</typeparam>
|
|
<remarks>
|
|
This serializer is intended to support self-composit structure like directories or XML nodes.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.LazyDelegatingMessagePackSerializer`1.#ctor(MsgPack.Serialization.SerializationContext,System.Object)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.LazyDelegatingMessagePackSerializer`1"/> class.
|
|
</summary>
|
|
<param name="ownerContext">
|
|
The serialization context to support lazy retrieval.
|
|
</param>
|
|
<param name="providerParameter">A provider parameter to be passed in future.</param>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.MessagePackEnumAttribute">
|
|
<summary>
|
|
Marks that this enum type has special characteristics on MessagePack serialization.
|
|
</summary>
|
|
<remarks>
|
|
Enum types which are not marked with this attribute will be serialized as <see cref="P:MsgPack.Serialization.SerializationContext.EnumSerializationMethod"/> value.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackEnumAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackEnumAttribute"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.MessagePackEnumAttribute.SerializationMethod">
|
|
<summary>
|
|
Gets or sets the default serialization method for this enum type.
|
|
</summary>
|
|
<value>
|
|
The default serialization method for this enum type.
|
|
Note that the method for individual enum typed members will be overrided with <see cref="T:MsgPack.Serialization.MessagePackEnumMemberAttribute"/>.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.MessagePackEnumMemberAttribute">
|
|
<summary>
|
|
Marks that this enum typed member has special characteristics on MessagePack serialization.
|
|
</summary>
|
|
<remarks>
|
|
If this attributes is used for non-enum typed members, this attribute will be ignored.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackEnumMemberAttribute.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackEnumMemberAttribute"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.MessagePackEnumMemberAttribute.SerializationMethod">
|
|
<summary>
|
|
Gets or sets the default serialization method for this enum typed member.
|
|
</summary>
|
|
<value>
|
|
The default serialization method for this enum typed member.
|
|
Note that the method for the enum type will be overrided with this.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.MessagePackMemberAttribute">
|
|
<summary>
|
|
Marks a field or a property to be serialized with MessagePack Serializer and defines some required informations to serialize.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackMemberAttribute.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.MessagePackMemberAttribute"/> class.
|
|
</summary>
|
|
<param name="id">
|
|
The ID of the member. This value cannot be negative and must be unique in the type.
|
|
</param>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.MessagePackMemberAttribute.Id">
|
|
<summary>
|
|
Gets the ID of the member.
|
|
</summary>
|
|
<value>
|
|
The ID of the member.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.MessagePackMemberAttribute.Name">
|
|
<summary>
|
|
Gets or sets the name of this member.
|
|
</summary>
|
|
<value>
|
|
The name which will be used in map key on serialized MessagePack stream.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.MessagePackMemberAttribute.NilImplication">
|
|
<summary>
|
|
Gets or sets the implication of the nil value.
|
|
</summary>
|
|
<value>
|
|
The implication of the nil value.
|
|
Default value is <see cref="F:NilImplication.MemberDefault"/>.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.MessagePackSerializer">
|
|
<summary>
|
|
Defines entry points for <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> usage.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Create``1">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance with <see cref="P:MsgPack.Serialization.SerializationContext.Default"/>.
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<returns>
|
|
New <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance to serialize/deserialize the object tree which the top is <typeparamref name="T"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Create``1(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance with specified <see cref="T:MsgPack.Serialization.SerializationContext"/>.
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<param name="context">
|
|
<see cref="T:MsgPack.Serialization.SerializationContext"/> to store known/created serializers.
|
|
</param>
|
|
<returns>
|
|
New <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance to serialize/deserialize the object tree which the top is <typeparamref name="T"/>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get``1">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance with default context (<see cref="P:MsgPack.Serialization.SerializationContext.Default"/>).
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<remarks>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.MessagePackSerializer.Get``1(MsgPack.Serialization.SerializationContext)"/> with <see cref="P:MsgPack.Serialization.SerializationContext.Default"/> for the <c>context</c>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get``1(System.Object)">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance with default context (<see cref="P:MsgPack.Serialization.SerializationContext.Default"/>).
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<param name="providerParameter">A provider specific parameter. See remarks section for details.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<remarks>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.MessagePackSerializer.Get``1(MsgPack.Serialization.SerializationContext,System.Object)"/> with <see cref="P:MsgPack.Serialization.SerializationContext.Default"/> for the <c>context</c>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get``1(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance with specified <see cref="T:MsgPack.Serialization.SerializationContext"/>.
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<param name="context">
|
|
<see cref="T:MsgPack.Serialization.SerializationContext"/> to store known/created serializers.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.MessagePackSerializer.Get``1(MsgPack.Serialization.SerializationContext,System.Object)"/> with <c>null</c> for the <c>providerParameter</c>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get``1(MsgPack.Serialization.SerializationContext,System.Object)">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance with specified <see cref="T:MsgPack.Serialization.SerializationContext"/>.
|
|
</summary>
|
|
<typeparam name="T">Target type.</typeparam>
|
|
<param name="context">
|
|
<see cref="T:MsgPack.Serialization.SerializationContext"/> to store known/created serializers.
|
|
</param>
|
|
<param name="providerParameter">A provider specific parameter. See remarks section for details.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer``1(System.Object)"/>, so see the method description for details.
|
|
</para>
|
|
<para>
|
|
Currently, only following provider parameters are supported.
|
|
<list type="table">
|
|
<listheader>
|
|
<term>Target type</term>
|
|
<description>Provider parameter</description>
|
|
</listheader>
|
|
<item>
|
|
<term><see cref="T:MsgPack.Serialization.EnumMessagePackSerializer`1"/> or its descendants.</term>
|
|
<description><see cref="T:MsgPack.Serialization.EnumSerializationMethod"/>. The returning instance corresponds to this value for serialization.</description>
|
|
</item>
|
|
</list>
|
|
<note><c>null</c> is valid value for <paramref name="providerParameter"/> and it indeicates default behavior of parameter.</note>
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Create(System.Type)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> instance with <see cref="P:MsgPack.Serialization.SerializationContext.Default"/>.
|
|
</summary>
|
|
<param name="targetType">Target type.</param>
|
|
<returns>
|
|
New <see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/> instance to serialize/deserialize the object tree which the top is <paramref name="targetType"/>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
To avoid boxing and strongly typed API is prefered, use <see cref="M:MsgPack.Serialization.MessagePackSerializer.Create``1"/> instead when possible.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Create(System.Type,MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Creates new <see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> instance with specified <see cref="T:MsgPack.Serialization.SerializationContext"/>.
|
|
</summary>
|
|
<param name="targetType">Target type.</param>
|
|
<param name="context">
|
|
<see cref="T:MsgPack.Serialization.SerializationContext"/> to store known/created serializers.
|
|
</param>
|
|
<returns>
|
|
New <see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/> instance to serialize/deserialize the object tree which the top is <paramref name="targetType"/>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
Or, <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
To avoid boxing and strongly typed API is prefered, use <see cref="M:MsgPack.Serialization.MessagePackSerializer.Create``1(MsgPack.Serialization.SerializationContext)"/> instead when possible.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get(System.Type)">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> instance with default context (<see cref="P:MsgPack.Serialization.SerializationContext.Default"/>).
|
|
</summary>
|
|
<param name="targetType">Target type.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer(System.Type)"/>, so see the method description for details.
|
|
</para>
|
|
<para>
|
|
Although <see cref="M:MsgPack.Serialization.MessagePackSerializer.Get``1"/> is preferred,
|
|
this method can be used from non-generic type or methods.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get(System.Type,System.Object)">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> instance with default context (<see cref="P:MsgPack.Serialization.SerializationContext.Default"/>).
|
|
</summary>
|
|
<param name="targetType">Target type.</param>
|
|
<param name="providerParameter">A provider specific parameter. See remarks section for details.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer(System.Type,System.Object)"/>, so see the method description for details.
|
|
</para>
|
|
<para>
|
|
Although <see cref="M:MsgPack.Serialization.MessagePackSerializer.Get``1(System.Object)"/> is preferred,
|
|
this method can be used from non-generic type or methods.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get(System.Type,MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> instance with specified <see cref="T:MsgPack.Serialization.SerializationContext"/>.
|
|
</summary>
|
|
<param name="targetType">Target type.</param>
|
|
<param name="context">
|
|
<see cref="T:MsgPack.Serialization.SerializationContext"/> to store known/created serializers.
|
|
</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
Or, <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer(System.Type)"/>, so see the method description for details.
|
|
</para>
|
|
<para>
|
|
Although <see cref="M:MsgPack.Serialization.MessagePackSerializer.Get``1(MsgPack.Serialization.SerializationContext)"/> is preferred,
|
|
this method can be used from non-generic type or methods.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializer.Get(System.Type,MsgPack.Serialization.SerializationContext,System.Object)">
|
|
<summary>
|
|
Gets existing or new <see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> instance with specified <see cref="T:MsgPack.Serialization.SerializationContext"/>.
|
|
</summary>
|
|
<param name="targetType">Target type.</param>
|
|
<param name="context">
|
|
<see cref="T:MsgPack.Serialization.SerializationContext"/> to store known/created serializers.
|
|
</param>
|
|
<param name="providerParameter">A provider specific parameter. See remarks section for details.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
Or, <paramref name="context"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
This method simply invokes <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer(System.Type,System.Object)"/>, so see the method description for details.
|
|
</para>
|
|
<para>
|
|
Although <see cref="M:MsgPack.Serialization.MessagePackSerializer.Get``1(MsgPack.Serialization.SerializationContext,System.Object)"/> is preferred,
|
|
this method can be used from non-generic type or methods.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.MessagePackSerializerExtensions">
|
|
<summary>
|
|
Defines convinient extension methods for interfaces.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializerExtensions.Pack(MsgPack.Serialization.IMessagePackSerializer,System.IO.Stream,System.Object)">
|
|
<summary>
|
|
Serializes specified object to the <see cref="T:System.IO.Stream"/> with default <see cref="T:MsgPack.PackerCompatibilityOptions"/>.
|
|
</summary>
|
|
<param name="source"><see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> object.</param>
|
|
<param name="stream">Destination <see cref="T:System.IO.Stream"/>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="stream"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to serialize <paramref name="objectTree"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializerExtensions.Pack(MsgPack.Serialization.IMessagePackSerializer,System.IO.Stream,System.Object,MsgPack.PackerCompatibilityOptions)">
|
|
<summary>
|
|
Serializes specified object to the <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source"><see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> object.</param>
|
|
<param name="stream">Destination <see cref="T:System.IO.Stream"/>.</param>
|
|
<param name="objectTree">Object to be serialized.</param>
|
|
<param name="packerCompatibilityOptions">A <see cref="T:MsgPack.PackerCompatibilityOptions"/> which specifies compatibility options.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="stream"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to serialize <paramref name="objectTree"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.MessagePackSerializerExtensions.Unpack(MsgPack.Serialization.IMessagePackSerializer,System.IO.Stream)">
|
|
<summary>
|
|
Deserialize object from the <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source"><see cref="T:MsgPack.Serialization.IMessagePackSerializer"/> object.</param>
|
|
<param name="stream">Source <see cref="T:System.IO.Stream"/>.</param>
|
|
<returns>Deserialized object.</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="stream"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialize from <paramref name="stream"/>.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.NilImplication">
|
|
<summary>
|
|
Specifies nil implication in serialization/deserialization.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.NilImplication.MemberDefault">
|
|
<summary>
|
|
A nil is interpreted as default value of the member.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This value affects only deserialization.
|
|
</para>
|
|
<para>
|
|
If the unpacking value is nil, the serializer will not set any value to the member.
|
|
</para>
|
|
<para>
|
|
This value corresponds to <c>optional</c> on the IDL.
|
|
</para>
|
|
<note>
|
|
This is default option because the most safe option.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.NilImplication.Null">
|
|
<summary>
|
|
A nil is interpreted as <c>null</c>.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This value affects only deserialization.
|
|
</para>
|
|
<para>
|
|
If the unpacking value is nil, the serializer will set <c>null</c> to the member.
|
|
If the member is non-nullable value type and the packed value is nil, then <see cref="T:System.Runtime.Serialization.SerializationException"/> will be thrown.
|
|
</para>
|
|
<para>
|
|
This value corresponds to <c>nullable required</c> on the IDL.
|
|
</para>
|
|
<note>
|
|
If the destination end point sends nil for the value type member like <see cref="T:System.Int32"/> type,
|
|
you can avoid the exception with change the type of the member to nullable value type.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.NilImplication.Prohibit">
|
|
<summary>
|
|
A nil is prohibitted.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This value affects both of serialization and deserialization.
|
|
</para>
|
|
<para>
|
|
If the packing value is <c>null</c> or the unpacking value is nil,
|
|
the serializer will throw exception.
|
|
</para>
|
|
<para>
|
|
This value corresponds to <c>required</c> on the IDL.
|
|
</para>
|
|
<note>
|
|
When you specify this value to newly added member,
|
|
it means that you BREAK backword compatibility.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ReflectionSerializers.ReflectionCollectionSerializer`1">
|
|
<summary>
|
|
Wrapper to simulate type argument variance.
|
|
</summary>
|
|
<typeparam name="T">Actual collection type.</typeparam>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ReflectionSerializers.ReflectionEnumMessagePackSerializer`1">
|
|
<summary>
|
|
Implements reflection-based enum serializer for restricted platforms.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ReflectionSerializers.ReflectionObjectMessagePackSerializer`1">
|
|
<summary>
|
|
Implements reflection-based object serializer for restricted platforms.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ReflectionSerializers.ReflectionSerializerHelper">
|
|
<summary>
|
|
Helper static methods for reflection serializers.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ReflectionSerializers.ReflectionTupleMessagePackSerializer`1">
|
|
<summary>
|
|
Implements reflection-based tuple serializer for restricted platforms.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.Reflection.GenericTypeExtensions">
|
|
<summary>
|
|
Define utility extension method for generic type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.GenericTypeExtensions.Implements(System.Type,System.Type)">
|
|
<summary>
|
|
Determine whether the source type implements specified generic type or its built type.
|
|
</summary>
|
|
<param name="source">Target type.</param>
|
|
<param name="genericType">Generic interface type.</param>
|
|
<returns>
|
|
<c>true</c> if <paramref name="source"/> implements <paramref name="genericType"/>,
|
|
or built closed generic interface type;
|
|
otherwise <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.GenericTypeExtensions.GetName(System.Type)">
|
|
<summary>
|
|
Get name of type without namespace and assembly name of itself and its generic arguments.
|
|
</summary>
|
|
<param name="source">Target type.</param>
|
|
<returns>Simple name of type.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.GenericTypeExtensions.GetFullName(System.Type)">
|
|
<summary>
|
|
Get full name of type including namespace and excluding assembly name of itself and its generic arguments.
|
|
</summary>
|
|
<param name="source">Target type.</param>
|
|
<returns>Full name of type.</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.Reflection.ReflectionExtensions">
|
|
<summary>
|
|
Defines utility extension method for reflection API.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.ReflectionExtensions.IsAssignableTo(System.Type,System.Type)">
|
|
<summary>
|
|
Determines whether specified <see cref="T:System.Type"/> can be assigned to source <see cref="T:System.Type"/>.
|
|
</summary>
|
|
<param name="source">The source type.</param>
|
|
<param name="target">The type to compare with the source type.</param>
|
|
<returns>
|
|
<c>true</c> if <paramref name="source"/> and <paramref name="target"/> represent the same type,
|
|
or if <paramref name="target"/> is in the inheritance hierarchy of <paramref name="source"/>,
|
|
or if <paramref name="target"/> is an interface that <paramref name="source"/> implements,
|
|
or if <paramref name="source"/> is a generic type parameter and <paramref name="target"/> represents one of the constraints of <paramref name="source"/>.
|
|
<c>false</c> if none of these conditions are <c>true</c>, or if <paramref name="target"/> is <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.Reflection.TracingILGenerator">
|
|
<summary>
|
|
<see cref="T:System.Reflection.Emit.ILGenerator"/> like IL stream builder with tracing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitAnyCall(System.Reflection.MethodInfo)">
|
|
<summary>
|
|
Emit 'call' or 'callvirt' appropriately.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.MethodInfo"/> to be called.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitGetProperty(System.Reflection.PropertyInfo)">
|
|
<summary>
|
|
Emit property getter invocation.
|
|
Pre condition is there is target instance on the top of evaluation stack when <paramref name="property"/> is instance property.
|
|
Post condition are that target instance will be removed from the stack for instance property, and property value will be placed on there.
|
|
</summary>
|
|
<param name="property"><see cref="T:System.Reflection.PropertyInfo"/> for target property.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitAnyLdarg(System.Int32)">
|
|
<summary>
|
|
Emit apprpriate 'ldarg.*' instruction.
|
|
Post condition is that the loaded value will be added on the evaluation stack.
|
|
</summary>
|
|
<param name="argumentIndex">
|
|
Index of argument to be fetched.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitAnyLdloc(System.Int32)">
|
|
<summary>
|
|
Emit apprpriate 'ldloc.*' instruction.
|
|
Post condition is that the loaded value will be added on the evaluation stack.
|
|
</summary>
|
|
<param name="localIndex">
|
|
Index of local variable to be fetched.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitAnyStloc(System.Int32)">
|
|
<summary>
|
|
Emit array initialization code with initializer.
|
|
Pre condition is that the storing value is placed on the top of evaluation stack and its type is valid.
|
|
Post condition is that the stored value will be removed from the evaluation stack.
|
|
</summary>
|
|
<param name="localIndex">
|
|
Index of local variable which stores the array.
|
|
</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitNewarr(System.Type,System.Int64)">
|
|
<summary>
|
|
Emit array initialization code without initializer.
|
|
Post condition is evaluation stack will no be modified as previous state.
|
|
Note that initialized array is not placed on the top of evaluation stack.
|
|
</summary>
|
|
<param name="elementType"><see cref="T:System.Type"/> of array element. This can be generaic parameter.</param>
|
|
<param name="length">Size of array.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLiteralInteger(System.Int64)">
|
|
<summary>
|
|
Emit efficient integer constant loading.
|
|
Post condition is that exactly one integer will be added on the top of stack.
|
|
</summary>
|
|
<param name="value">Integer value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitTypeOf(System.Type)">
|
|
<summary>
|
|
Emit 'typeof' expression.
|
|
Post condition is <see cref="T:System.Type"/> instance for <paramref name="type"/> will be placed on the top of evaluation stack.
|
|
</summary>
|
|
<param name="type">Target <see cref="T:System.Type"/>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.#ctor(System.Reflection.Emit.DynamicMethod,System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> class.
|
|
</summary>
|
|
<param name="dynamicMethod">The dynamic method.</param>
|
|
<param name="traceWriter">The trace writer.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.#ctor(System.Reflection.Emit.MethodBuilder,System.IO.TextWriter,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> class.
|
|
</summary>
|
|
<param name="methodBuilder">The method builder.</param>
|
|
<param name="traceWriter">The trace writer.</param>
|
|
<param name="isDebuggable"><c>true</c> if the underlying builders are debuggable; othersie <c>false</c>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.#ctor(System.Reflection.Emit.ConstructorBuilder,System.IO.TextWriter,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.Reflection.TracingILGenerator"/> class.
|
|
</summary>
|
|
<param name="constructorBuilder">The constructor builder.</param>
|
|
<param name="traceWriter">The trace writer.</param>
|
|
<param name="isDebuggable"><c>true</c> if the underlying builders are debuggable; othersie <c>false</c>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.Dispose">
|
|
<summary>
|
|
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitRet">
|
|
<summary>
|
|
Emit 'ret' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.DeclareLocal(System.Type,System.String)">
|
|
<summary>
|
|
Declare local with name for debugging and without pinning.
|
|
Note that this method is not enabled for dynamic method.
|
|
</summary>
|
|
<param name="localType"><see cref="T:System.Type"/> of local variable.</param>
|
|
<param name="name">Name of the local variable.</param>
|
|
<returns><see cref="T:System.Reflection.Emit.LocalBuilder"/> to refer declared local variable.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.BeginExceptionBlock">
|
|
<summary>
|
|
Begin exception block (try in C#) here.
|
|
Note that you do not have to emit leave or laeve.s instrauction at tail of the body.
|
|
</summary>
|
|
<returns><see cref="T:System.Reflection.Emit.Label"/> will to be end of begun exception block.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.BeginFinallyBlock">
|
|
<summary>
|
|
Begin finally block.
|
|
Note that you do not have to emit endfinally instrauction at tail of the body.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EndExceptionBlock">
|
|
<summary>
|
|
End current exception block and its last clause.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.DefineLabel(System.String)">
|
|
<summary>
|
|
Define new <see cref="T:System.Reflection.Emit.Label"/> with name for tracing.
|
|
</summary>
|
|
<param name="name">Name of label. Note that debugging information will not have this name.</param>
|
|
<returns><see cref="T:System.Reflection.Emit.Label"/> which will be target of branch instructions.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.MarkLabel(System.Reflection.Emit.Label)">
|
|
<summary>
|
|
Mark current position using specifieid <see cref="T:System.Reflection.Emit.Label"/>.
|
|
</summary>
|
|
<param name="label"><see cref="T:System.Reflection.Emit.Label"/>.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.TraceWrite(System.String)">
|
|
<summary>
|
|
Write trace message.
|
|
</summary>
|
|
<param name="value">The string.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.TraceWriteLine">
|
|
<summary>
|
|
Write trace line break.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.TraceWriteLine(System.String)">
|
|
<summary>
|
|
Write trace message followed by line break.
|
|
</summary>
|
|
<param name="value">The string.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.TraceWriteLine(System.String,System.Object)">
|
|
<summary>
|
|
Write trace message followed by line break.
|
|
</summary>
|
|
<param name="format">The format string.</param>
|
|
<param name="arg0">Format argument.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarg_0">
|
|
<summary>
|
|
Emit 'ldarg.0' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarg_1">
|
|
<summary>
|
|
Emit 'ldarg.1' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarg_2">
|
|
<summary>
|
|
Emit 'ldarg.2' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarg_3">
|
|
<summary>
|
|
Emit 'ldarg.3' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloc_0">
|
|
<summary>
|
|
Emit 'ldloc.0' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloc_1">
|
|
<summary>
|
|
Emit 'ldloc.1' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloc_2">
|
|
<summary>
|
|
Emit 'ldloc.2' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloc_3">
|
|
<summary>
|
|
Emit 'ldloc.3' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStloc_0">
|
|
<summary>
|
|
Emit 'stloc.0' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStloc_1">
|
|
<summary>
|
|
Emit 'stloc.1' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStloc_2">
|
|
<summary>
|
|
Emit 'stloc.2' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStloc_3">
|
|
<summary>
|
|
Emit 'stloc.3' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarg_S(System.Byte)">
|
|
<summary>
|
|
Emit 'ldarg.s' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarga_S(System.Byte)">
|
|
<summary>
|
|
Emit 'ldarga.s' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloc_S(System.Byte)">
|
|
<summary>
|
|
Emit 'ldloc.s' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloca_S(System.Byte)">
|
|
<summary>
|
|
Emit 'ldloca.s' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStloc_S(System.Byte)">
|
|
<summary>
|
|
Emit 'stloc.s' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdnull">
|
|
<summary>
|
|
Emit 'ldnull' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_M1">
|
|
<summary>
|
|
Emit 'ldc.i4.m1' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_0">
|
|
<summary>
|
|
Emit 'ldc.i4.0' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_1">
|
|
<summary>
|
|
Emit 'ldc.i4.1' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_2">
|
|
<summary>
|
|
Emit 'ldc.i4.2' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_3">
|
|
<summary>
|
|
Emit 'ldc.i4.3' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_4">
|
|
<summary>
|
|
Emit 'ldc.i4.4' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_5">
|
|
<summary>
|
|
Emit 'ldc.i4.5' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_6">
|
|
<summary>
|
|
Emit 'ldc.i4.6' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_7">
|
|
<summary>
|
|
Emit 'ldc.i4.7' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_8">
|
|
<summary>
|
|
Emit 'ldc.i4.8' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4_S(System.Byte)">
|
|
<summary>
|
|
Emit 'ldc.i4.s' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Byte"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I4(System.Int32)">
|
|
<summary>
|
|
Emit 'ldc.i4' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int32"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdc_I8(System.Int64)">
|
|
<summary>
|
|
Emit 'ldc.i8' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.Int64"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitPop">
|
|
<summary>
|
|
Emit 'pop' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitCall(System.Reflection.MethodInfo)">
|
|
<summary>
|
|
Emit 'call' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.MethodInfo"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitBr(System.Reflection.Emit.Label)">
|
|
<summary>
|
|
Emit 'br' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.Emit.Label"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitBrfalse(System.Reflection.Emit.Label)">
|
|
<summary>
|
|
Emit 'brfalse' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.Emit.Label"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitBrtrue(System.Reflection.Emit.Label)">
|
|
<summary>
|
|
Emit 'brtrue' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.Emit.Label"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitBlt(System.Reflection.Emit.Label)">
|
|
<summary>
|
|
Emit 'blt' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.Emit.Label"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitAdd">
|
|
<summary>
|
|
Emit 'add' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitAnd">
|
|
<summary>
|
|
Emit 'and' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitCallvirt(System.Reflection.MethodInfo)">
|
|
<summary>
|
|
Emit 'callvirt' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.MethodInfo"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdstr(System.String)">
|
|
<summary>
|
|
Emit 'ldstr' instruction with specified arguments.
|
|
</summary>
|
|
<param name="value"><see cref="T:System.String"/> as value.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitNewobj(System.Reflection.ConstructorInfo)">
|
|
<summary>
|
|
Emit 'newobj' instruction with specified arguments.
|
|
</summary>
|
|
<param name="constructor"><see cref="T:System.Reflection.ConstructorInfo"/> as constructor.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitThrow">
|
|
<summary>
|
|
Emit 'throw' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdfld(System.Reflection.FieldInfo)">
|
|
<summary>
|
|
Emit 'ldfld' instruction with specified arguments.
|
|
</summary>
|
|
<param name="field"><see cref="T:System.Reflection.FieldInfo"/> as field.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdflda(System.Reflection.FieldInfo)">
|
|
<summary>
|
|
Emit 'ldflda' instruction with specified arguments.
|
|
</summary>
|
|
<param name="field"><see cref="T:System.Reflection.FieldInfo"/> as field.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStfld(System.Reflection.FieldInfo)">
|
|
<summary>
|
|
Emit 'stfld' instruction with specified arguments.
|
|
</summary>
|
|
<param name="field"><see cref="T:System.Reflection.FieldInfo"/> as field.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitBox(System.Type)">
|
|
<summary>
|
|
Emit 'box' instruction with specified arguments.
|
|
</summary>
|
|
<param name="type"><see cref="T:System.Type"/> as type.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitNewarr(System.Type)">
|
|
<summary>
|
|
Emit 'newarr' instruction with specified arguments.
|
|
</summary>
|
|
<param name="type"><see cref="T:System.Type"/> as type.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStelem(System.Type)">
|
|
<summary>
|
|
Emit 'stelem' instruction with specified arguments.
|
|
</summary>
|
|
<param name="type"><see cref="T:System.Type"/> as type.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitUnbox_Any(System.Type)">
|
|
<summary>
|
|
Emit 'unbox.any' instruction with specified arguments.
|
|
</summary>
|
|
<param name="type"><see cref="T:System.Type"/> as type.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdtoken(System.Type)">
|
|
<summary>
|
|
Emit 'ldtoken' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Type"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdtoken(System.Reflection.MethodBase)">
|
|
<summary>
|
|
Emit 'ldtoken' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.MethodBase"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdtoken(System.Reflection.FieldInfo)">
|
|
<summary>
|
|
Emit 'ldtoken' instruction with specified arguments.
|
|
</summary>
|
|
<param name="target"><see cref="T:System.Reflection.FieldInfo"/> as target.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitCeq">
|
|
<summary>
|
|
Emit 'ceq' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitCgt">
|
|
<summary>
|
|
Emit 'cgt' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitClt">
|
|
<summary>
|
|
Emit 'clt' instruction with specified arguments.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarg(System.Int32)">
|
|
<summary>
|
|
Emit 'ldarg' instruction with specified arguments.
|
|
</summary>
|
|
<param name="index"><see cref="T:System.Int32"/> as index.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdarga(System.Int32)">
|
|
<summary>
|
|
Emit 'ldarga' instruction with specified arguments.
|
|
</summary>
|
|
<param name="index"><see cref="T:System.Int32"/> as index.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloc(System.Int32)">
|
|
<summary>
|
|
Emit 'ldloc' instruction with specified arguments.
|
|
</summary>
|
|
<param name="index"><see cref="T:System.Int32"/> as index.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitLdloca(System.Int32)">
|
|
<summary>
|
|
Emit 'ldloca' instruction with specified arguments.
|
|
</summary>
|
|
<param name="index"><see cref="T:System.Int32"/> as index.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.Reflection.TracingILGenerator.EmitStloc(System.Int32)">
|
|
<summary>
|
|
Emit 'stloc' instruction with specified arguments.
|
|
</summary>
|
|
<param name="index"><see cref="T:System.Int32"/> as index.</param>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.Reflection.TracingILGenerator.EndOfMethod">
|
|
<summary>
|
|
Get <see cref="T:System.Reflection.Emit.Label"/> for end of method.
|
|
</summary>
|
|
<value>
|
|
<see cref="T:System.Reflection.Emit.Label"/> for end of method.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.Reflection.TracingILGenerator.IsInExceptionBlock">
|
|
<summary>
|
|
Get whether there are any exception blocks in current positon.
|
|
</summary>
|
|
<value>
|
|
If there are any exception blocks in current positon then <c>true</c>; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.Reflection.TracingILGenerator.IsEnded">
|
|
<summary>
|
|
Get whether this IL stream is ended with 'ret'.
|
|
</summary>
|
|
<returns>
|
|
When this IL stream is ended with 'ret' then <c>true</c>; otherwise, <c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializationCompatibilityOptions">
|
|
<summary>
|
|
Represents compatibility options of serialization runtime.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationCompatibilityOptions.OneBoundDataMemberOrder">
|
|
<summary>
|
|
Gets or sets a value indicating whether <c>System.Runtime.Serialization.DataMemberAttribute.Order</c> should be started with 1 instead of 0.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if <c>System.Runtime.Serialization.DataMemberAttribute.Order</c> should be started with 1 instead of 0; otherwise, <c>false</c>.
|
|
Default is <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
Using this value, you can switch between MessagePack for CLI and ProtoBuf.NET seamlessly.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationCompatibilityOptions.PackerCompatibilityOptions">
|
|
<summary>
|
|
Gets or sets the <see cref="P:MsgPack.Serialization.SerializationCompatibilityOptions.PackerCompatibilityOptions"/>.
|
|
</summary>
|
|
<value>
|
|
The <see cref="P:MsgPack.Serialization.SerializationCompatibilityOptions.PackerCompatibilityOptions"/>. The default is <see cref="F:PackerCompatibilityOptions.Classic"/>.
|
|
</value>
|
|
<remarks>
|
|
<note>
|
|
Changing this property value does not affect already built serializers -- especially built-in (default) serializers.
|
|
You must specify <see cref="T:PackerCompatibilityOptions"/> enumeration to the constructor of <see cref="T:MsgPack.Serialization.SerializationContext"/> to
|
|
change built-in serializers' behavior.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializationContext">
|
|
<summary>
|
|
<strong>This is intened to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Represents serialization context information for internal serialization logic.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationContext.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.SerializationContext"/> class with copy of <see cref="P:MsgPack.Serialization.SerializerRepository.Default"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationContext.#ctor(MsgPack.PackerCompatibilityOptions)">
|
|
<summary>
|
|
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"/>.
|
|
</summary>
|
|
<param name="packerCompatibilityOptions"><see cref="T:MsgPack.PackerCompatibilityOptions"/> which will be used on built-in serializers.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationContext.GetSerializer``1">
|
|
<summary>
|
|
Gets the <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> with this instance without provider parameter.
|
|
</summary>
|
|
<typeparam name="T">Type of serialization/deserialization target.</typeparam>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<remarks>
|
|
This method automatically register new instance via <see cref="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0})"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationContext.GetSerializer``1(System.Object)">
|
|
<summary>
|
|
Gets the <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> with this instance.
|
|
</summary>
|
|
<typeparam name="T">Type of serialization/deserialization target.</typeparam>
|
|
<param name="providerParameter">A provider specific parameter. See remarks section for details.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<remarks>
|
|
<para>
|
|
This method automatically register new instance via <see cref="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0})"/>.
|
|
</para>
|
|
<para>
|
|
Currently, only following provider parameters are supported.
|
|
<list type="table">
|
|
<listheader>
|
|
<term>Target type</term>
|
|
<description>Provider parameter</description>
|
|
</listheader>
|
|
<item>
|
|
<term><see cref="T:MsgPack.Serialization.EnumMessagePackSerializer`1"/> or its descendants.</term>
|
|
<description><see cref="P:MsgPack.Serialization.SerializationContext.EnumSerializationMethod"/>. The returning instance corresponds to this value for serialization.</description>
|
|
</item>
|
|
</list>
|
|
<note><c>null</c> is valid value for <paramref name="providerParameter"/> and it indeicates default behavior of parameter.</note>
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationContext.GetSerializer(System.Type)">
|
|
<summary>
|
|
Gets the serializer for the specified <see cref="T:System.Type"/>.
|
|
</summary>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
Although <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer``1"/> is preferred,
|
|
this method can be used from non-generic type or methods.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationContext.GetSerializer(System.Type,System.Object)">
|
|
<summary>
|
|
Gets the serializer for the specified <see cref="T:System.Type"/>.
|
|
</summary>
|
|
<param name="targetType">Type of the serialization target.</param>
|
|
<param name="providerParameter">A provider specific parameter. See remarks section of <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer``1(System.Object)"/> for details.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.IMessagePackSingleObjectSerializer"/>.
|
|
If there is exiting one, returns it.
|
|
Else the new instance will be created.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="targetType"/> is <c>null</c>.
|
|
</exception>
|
|
<remarks>
|
|
Although <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer``1(System.Object)"/> is preferred,
|
|
this method can be used from non-generic type or methods.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.Default">
|
|
<summary>
|
|
Gets or sets the default instance.
|
|
</summary>
|
|
<value>
|
|
The default <see cref="T:MsgPack.Serialization.SerializationContext"/> instance.
|
|
</value>
|
|
<exception cref="T:System.ArgumentNullException">The setting value is <c>null</c>.</exception>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.Serializers">
|
|
<summary>
|
|
Gets the current <see cref="T:MsgPack.Serialization.SerializerRepository"/>.
|
|
</summary>
|
|
<value>
|
|
The current <see cref="T:MsgPack.Serialization.SerializerRepository"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.EmitterFlavor">
|
|
<summary>
|
|
Gets or sets the <see cref="P:MsgPack.Serialization.SerializationContext.EmitterFlavor"/>.
|
|
</summary>
|
|
<value>
|
|
The <see cref="P:MsgPack.Serialization.SerializationContext.EmitterFlavor"/>
|
|
</value>
|
|
<remarks>
|
|
For testing purposes.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.CompatibilityOptions">
|
|
<summary>
|
|
Gets the compatibility options.
|
|
</summary>
|
|
<value>
|
|
The <see cref="T:MsgPack.Serialization.SerializationCompatibilityOptions"/> which stores compatibility options. This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.SerializationMethod">
|
|
<summary>
|
|
Gets or sets the <see cref="P:MsgPack.Serialization.SerializationContext.SerializationMethod"/> to determine serialization strategy.
|
|
</summary>
|
|
<value>
|
|
The <see cref="P:MsgPack.Serialization.SerializationContext.SerializationMethod"/> to determine serialization strategy.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.EnumSerializationMethod">
|
|
<summary>
|
|
Gets or sets the <see cref="P:MsgPack.Serialization.SerializationContext.EnumSerializationMethod"/> to determine default serialization strategy of enum types.
|
|
</summary>
|
|
<value>
|
|
The <see cref="P:MsgPack.Serialization.SerializationContext.EnumSerializationMethod"/> to determine default serialization strategy of enum types.
|
|
</value>
|
|
<remarks>
|
|
A serialization strategy for specific <strong>member</strong> is determined as following:
|
|
<list type="numeric">
|
|
<item>If the member is marked with <see cref="T:MsgPack.Serialization.MessagePackEnumMemberAttribute"/> and its value is not <see cref="F:MsgPack.Serialization.EnumMemberSerializationMethod.Default"/>, then it will be used.</item>
|
|
<item>Otherwise, if the enum type itself is marked with <see cref="T:MsgPack.Serialization.MessagePackEnumAttribute"/>, then it will be used.</item>
|
|
<item>Otherwise, the value of this property will be used.</item>
|
|
</list>
|
|
Note that the default value of this property is <see cref="T:EnumSerializationMethod.ByName"/>, it is not size efficient but tolerant to unexpected enum definition change.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.GeneratorOption">
|
|
<summary>
|
|
Gets or sets the <see cref="T:MsgPack.Serialization.SerializationMethodGeneratorOption"/> to control code generation.
|
|
</summary>
|
|
<value>
|
|
The <see cref="T:MsgPack.Serialization.SerializationMethodGeneratorOption"/>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.DefaultCollectionTypes">
|
|
<summary>
|
|
Gets the default collection types.
|
|
</summary>
|
|
<value>
|
|
The default collection types. This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializationContext.IsRuntimeGenerationDisabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether runtime generation is disabled or not.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if runtime generation is disabled; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializationExceptions">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Defines common exception factory methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewValueTypeCannotBeNull(System.String,System.Type,System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that value type cannot be <c>null</c> on deserialization.
|
|
</summary>
|
|
<param name="name">The name of the member.</param>
|
|
<param name="memberType">The type of the member.</param>
|
|
<param name="declaringType">The type that declares the member.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewValueTypeCannotBeNull(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that value type cannot be <c>null</c> on deserialization.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewTypeCannotSerialize(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that value type cannot serialize.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewTypeCannotDeserialize(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that value type cannot deserialize.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewTypeCannotDeserialize(System.Type,System.String,System.Exception)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that value type cannot deserialize.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<param name="memberName">The name of deserializing member.</param>
|
|
<param name="inner">The inner exception.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.SerializationExceptions.NewMissingItemMethod">
|
|
<summary>
|
|
<see cref="T:System.Reflection.MethodInfo"/> of <see cref="M:MsgPack.Serialization.SerializationExceptions.NewMissingItem(System.Int32)"/> method.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewMissingItem(System.Int32)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that item is not found on the unpacking stream.
|
|
</summary>
|
|
<param name="index">The index to be unpacking.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewTargetDoesNotHavePublicDefaultConstructor(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that target type is not serializable because it does not have public default constructor.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewTargetDoesNotHavePublicDefaultConstructorNorInitialCapacity(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that target type is not serializable because it does not have both of public default constructor and public constructor with an Int32 parameter.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewNoSerializableFieldsException(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that there are no serializable fields and properties on the target type.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewMissingProperty(System.String)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that required field is not found on the unpacking stream.
|
|
</summary>
|
|
<param name="name">The name of the property.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewUnexpectedEndOfStream">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that unpacking stream ends on unexpectedly position.
|
|
</summary>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewMissingAddMethod(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that target collection type does not declare appropriate Add(T) method.
|
|
</summary>
|
|
<param name="type">The target type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewIsNotArrayHeader">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that unpacker is not in the array header, that is the state is invalid.
|
|
</summary>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewIsNotMapHeader">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that unpacker is not in the array header, that is the state is invalid.
|
|
</summary>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewNotSupportedBecauseCannotInstanciateAbstractType(System.Type)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that operation is not supported because <paramref name="type"/> cannot be instanciated.
|
|
</summary>
|
|
<param name="type">Type.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewTupleCardinarityIsNotMatch(System.Int32,System.Int32)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that the array length does not match to expected tuple cardinality.
|
|
</summary>
|
|
<param name="expectedTupleCardinality">The expected cardinality of the tuple.</param>
|
|
<param name="actualArrayLength">The actual serialized array length.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewIsIncorrectStream(System.Exception)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that the underlying stream is not correct semantically because failed to unpack items count of array/map.
|
|
</summary>
|
|
<param name="innerException">The inner exception for the debug. The value is implementation specific.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewIsTooLargeCollection">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that the unpacking collection is too large to represents in the current runtime environment.
|
|
</summary>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewNullIsProhibited(System.String)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that the member cannot be <c>null</c> or the unpacking value cannot be nil because nil value is explicitly prohibitted.
|
|
</summary>
|
|
<param name="memberName">The name of the member.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewReadOnlyMemberItemsMustNotBeNull(System.String)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that the unpacking value cannot be nil because the target member is read only and its type is collection.
|
|
</summary>
|
|
<param name="memberName">The name of the member.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewStreamDoesNotContainCollectionForMember(System.String)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that the unpacking collection value is not a collection.
|
|
</summary>
|
|
<param name="memberName">The name of the member.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewUnexpectedArrayLength(System.Int32,System.Int32)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that the unpacking array size is not expected length.
|
|
</summary>
|
|
<param name="expectedLength">Expected, required for deserialization array length.</param>
|
|
<param name="actualLength">Actual array length.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializationExceptions.NewFailedToDeserializeMember(System.Type,System.String,System.Exception)">
|
|
<summary>
|
|
<strong>This is intended to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Returns new exception to notify that it is failed to deserialize member.
|
|
</summary>
|
|
<param name="targetType">Deserializing type.</param>
|
|
<param name="memberName">The name of the deserializing member.</param>
|
|
<param name="inner">The exception which caused current error.</param>
|
|
<returns><see cref="T:System.Exception"/> instance. It will not be <c>null</c>.</returns>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializationMethod">
|
|
<summary>
|
|
Represents serialization method for complex types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.SerializationMethod.Array">
|
|
<summary>
|
|
The object will be serialized as array which is ordered by member ID.
|
|
This is default and more interoperable option.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.SerializationMethod.Map">
|
|
<summary>
|
|
The object will be serialized as map which is ordered by member ID.
|
|
This is a bit slower than array, but more stable for forward/backward compatibility.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializationMethodGeneratorOption">
|
|
<summary>
|
|
Define options of serializer generation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:MsgPack.Serialization.SerializationMethodGeneratorOption.Fast">
|
|
<summary>
|
|
Prefer performance. This options is default.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializationTarget">
|
|
<summary>
|
|
Implements serialization target member extraction logics.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializerDebugging">
|
|
<summary>
|
|
Holds debugging support information.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerDebugging.TraceEvent(System.String,System.Object[])">
|
|
<summary>
|
|
Traces the specific event.
|
|
</summary>
|
|
<param name="format">The format string.</param>
|
|
<param name="args">The args for formatting.</param>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerDebugging.FlushTraceData">
|
|
<summary>
|
|
Flushes the trace data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerDebugging.Reset">
|
|
<summary>
|
|
Resets debugging states.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializerDebugging.TraceEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether instruction/expression tracing is enabled or not.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if instruction/expression tracing is enabled; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializerDebugging.DumpEnabled">
|
|
<summary>
|
|
Gets or sets a value indicating whether IL dump is enabled or not.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if IL dump is enabled; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializerDebugging.AvoidsGenericSerializer">
|
|
<summary>
|
|
Gets or sets a value indicating whether generic serializer for array, <see cref="T:System.Collections.Generic.List`1"/>, <see cref="T:System.Collections.Generic.Dictionary`2"/>,
|
|
or <see cref="T:System.Nullable`1"/> is not used.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if generic serializer is not used; otherwise, <c>false</c>.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializerDebugging.ILTraceWriter">
|
|
<summary>
|
|
Gets the <see cref="T:System.IO.TextWriter"/> for IL tracing.
|
|
</summary>
|
|
<value>
|
|
The <see cref="T:System.IO.TextWriter"/> for IL tracing.
|
|
This value will not be <c>null</c>.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializerRepository">
|
|
<summary>
|
|
Repository of known <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>s.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.#ctor">
|
|
<summary>
|
|
Initializes a new empty instance of the <see cref="T:MsgPack.Serialization.SerializerRepository"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.#ctor(MsgPack.Serialization.SerializerRepository)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.Serialization.SerializerRepository"/> class which has copied serializers.
|
|
</summary>
|
|
<param name="copiedFrom">The repository which will be copied its contents.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="copiedFrom"/> is <c>null</c>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.Dispose">
|
|
<summary>
|
|
This method does not perform any operation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.Get``1(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Gets the registered <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> from this repository without provider parameter.
|
|
</summary>
|
|
<typeparam name="T">Type of the object to be marshaled/unmarshaled.</typeparam>
|
|
<param name="context">A serialization context.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>. If no appropriate mashalers has benn registered, then <c>null</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.Get``1(MsgPack.Serialization.SerializationContext,System.Object)">
|
|
<summary>
|
|
Gets the registered <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> from this repository with specified provider parameter.
|
|
</summary>
|
|
<typeparam name="T">Type of the object to be marshaled/unmarshaled.</typeparam>
|
|
<param name="context">A serialization context.</param>
|
|
<param name="providerParameter">A provider specific parameter. See remarks section of <see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer``1(System.Object)"/> for details.</param>
|
|
<returns>
|
|
<see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>. If no appropriate mashalers has benn registered, then <c>null</c>.
|
|
</returns>
|
|
<see cref="M:MsgPack.Serialization.SerializationContext.GetSerializer``1(System.Object)"/>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.Register``1(MsgPack.Serialization.MessagePackSerializer{``0})">
|
|
<summary>
|
|
Registers a <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of serialization target.</typeparam>
|
|
<param name="serializer"><see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance.</param>
|
|
<returns>
|
|
<c>true</c> if success to register; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="serializer"/> is <c>null</c>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.RegisterOverride``1(MsgPack.Serialization.MessagePackSerializer{``0})">
|
|
<summary>
|
|
Registers a <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> forcibley.
|
|
</summary>
|
|
<typeparam name="T">The type of serialization target.</typeparam>
|
|
<param name="serializer"><see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/> instance.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="serializer"/> is <c>null</c>.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.GetDefault(MsgPack.PackerCompatibilityOptions)">
|
|
<summary>
|
|
Gets the system default repository bound to default context.
|
|
</summary>
|
|
<param name="packerCompatibilityOptions"><see cref="T:MsgPack.PackerCompatibilityOptions"/> for default serializers must use.</param>
|
|
<returns>
|
|
The system default repository.
|
|
This value will not be <c>null</c>.
|
|
Note that the repository is frozen.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="packerCompatibilityOptions"/> is invalid.</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.SerializerRepository.GetDefault(MsgPack.Serialization.SerializationContext)">
|
|
<summary>
|
|
Gets the system default repository bound for specified context.
|
|
</summary>
|
|
<param name="ownerContext">A <see cref="T:MsgPack.Serialization.SerializationContext"/> which will be bound to default serializers.</param>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="ownerContext"/> is <c>null</c>.</exception>
|
|
<returns>
|
|
The system default repository.
|
|
This value will not be <c>null</c>.
|
|
Note that the repository is frozen.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.Serialization.SerializerRepository.Default">
|
|
<summary>
|
|
Gets the system default repository bound to default context.
|
|
</summary>
|
|
<value>
|
|
The system default repository.
|
|
This value will not be <c>null</c>.
|
|
Note that the repository is frozen.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializerTypeKeyRepository">
|
|
<summary>
|
|
Specialized <see cref="T:MsgPack.Serialization.TypeKeyRepository"/> for serializers.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.TypeKeyRepository">
|
|
<summary>
|
|
Repository for key type with RWlock scheme.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SerializingMember">
|
|
<summary>
|
|
Represents serializing member information.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.UnpackHelpers">
|
|
<summary>
|
|
<strong>This is intened to MsgPack for CLI internal use. Do not use this type from application directly.</strong>
|
|
Defines serialization helper APIs.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackArrayTo``1(MsgPack.Unpacker,MsgPack.Serialization.MessagePackSerializer{``0},``0[])">
|
|
<summary>
|
|
Unpacks the array to the specified array.
|
|
</summary>
|
|
<typeparam name="T">The type of the array element.</typeparam>
|
|
<param name="unpacker">The unpacker to unpack the underlying stream.</param>
|
|
<param name="serializer">The serializer to deserialize array.</param>
|
|
<param name="array">The array instance to be filled.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialization.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackCollectionTo(MsgPack.Unpacker,System.Collections.IEnumerable,System.Action{System.Object})">
|
|
<summary>
|
|
Unpacks the collection with the specified method as colletion of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to unpack the underlying stream.</param>
|
|
<param name="collection">The non-generic collection instance to be added unpacked elements.</param>
|
|
<param name="addition">The delegate which contains the instance method of the <paramref name="collection"/>. The parameter is unpacked object.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialization.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackCollectionTo``1(MsgPack.Unpacker,MsgPack.Serialization.MessagePackSerializer{``0},System.Collections.Generic.IEnumerable{``0},System.Action{``0})">
|
|
<summary>
|
|
Unpacks the dictionary with the specified method as colletion of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of elements.</typeparam>
|
|
<param name="unpacker">The unpacker to unpack the underlying stream.</param>
|
|
<param name="serializer">The serializer to deserialize elements.</param>
|
|
<param name="collection">The generic collection instance to be added unpacked elements.</param>
|
|
<param name="addition">The delegate which contains the instance method of the <paramref name="collection"/>. The parameter is unpacked object.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialization.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackCollectionTo``1(MsgPack.Unpacker,System.Collections.IEnumerable,System.Func{System.Object,``0})">
|
|
<summary>
|
|
Unpacks the collection with the specified method as colletion of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<typeparam name="TDiscarded">The return type of Add method.</typeparam>
|
|
<param name="unpacker">The unpacker to unpack the underlying stream.</param>
|
|
<param name="collection">The non-generic collection instance to be added unpacked elements.</param>
|
|
<param name="addition">The delegate which contains the instance method of the <paramref name="collection"/>. The parameter is unpacked object.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialization.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackCollectionTo``2(MsgPack.Unpacker,MsgPack.Serialization.MessagePackSerializer{``0},System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1})">
|
|
<summary>
|
|
Unpacks the dictionary with the specified method as colletion of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<typeparam name="T">The type of elements.</typeparam>
|
|
<typeparam name="TDiscarded">The return type of Add method.</typeparam>
|
|
<param name="unpacker">The unpacker to unpack the underlying stream.</param>
|
|
<param name="serializer">The serializer to deserialize elements.</param>
|
|
<param name="collection">The generic collection instance to be added unpacked elements.</param>
|
|
<param name="addition">The delegate which contains the instance method of the <paramref name="collection"/>. The parameter is unpacked object.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialization.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackMapTo``2(MsgPack.Unpacker,MsgPack.Serialization.MessagePackSerializer{``0},MsgPack.Serialization.MessagePackSerializer{``1},System.Collections.Generic.IDictionary{``0,``1})">
|
|
<summary>
|
|
Unpacks the dictionary with the specified method as colletion of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<typeparam name="TKey">The type of keys.</typeparam>
|
|
<typeparam name="TValue">The type of values.</typeparam>
|
|
<param name="unpacker">The unpacker to unpack the underlying stream.</param>
|
|
<param name="keySerializer">The serializer to deserialize key elements.</param>
|
|
<param name="valueSerializer">The serializer to deserialize value elements.</param>
|
|
<param name="dictionary">The generic dictionary instance to be added unpacked elements.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialization.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackMapTo(MsgPack.Unpacker,System.Collections.IDictionary)">
|
|
<summary>
|
|
Unpacks the dictionary with the specified method as colletion of <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to unpack the underlying stream.</param>
|
|
<param name="dictionary">The non-generic dictionary instance to be added unpacked elements.</param>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to deserialization.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.GetItemsCount(MsgPack.Unpacker)">
|
|
<summary>
|
|
Gets the items count as <see cref="T:System.Int32"/>.
|
|
</summary>
|
|
<param name="unpacker">The unpacker.</param>
|
|
<returns>The items count as <see cref="T:System.Int32"/>.</returns>
|
|
<exception cref="T:System.ArgumentNullException"><paramref name="unpacker"/> is <c>null.</c></exception>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">The items count is greater than <see cref="F:System.Int32.MaxValue"/>.</exception>
|
|
<remarks>
|
|
The items count of the collection can be between <see cref="F:System.Int32.MaxValue"/> and <see cref="F:System.UInt32.MaxValue"/>,
|
|
but most collections do not support so big count.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.ConvertWithEnsuringNotNull``1(System.Object,System.String,System.Type)">
|
|
<summary>
|
|
Ensures the boxed type is not null thus it cannot be unboxing.
|
|
</summary>
|
|
<typeparam name="T">The type of the member.</typeparam>
|
|
<param name="boxed">The boxed deserializing value.</param>
|
|
<param name="name">The name of the member.</param>
|
|
<param name="targetType">The type of the target.</param>
|
|
<returns>The unboxed value.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.InvokeUnpackFrom``1(MsgPack.Serialization.MessagePackSerializer{``0},MsgPack.Unpacker)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Serialization.MessagePackSerializer`1.UnpackFromCore(MsgPack.Unpacker)"/> FAMANDASM method directly.
|
|
</summary>
|
|
<typeparam name="T">The type of deserializing object.</typeparam>
|
|
<param name="serializer">The invocation target <see cref="T:MsgPack.Serialization.MessagePackSerializer`1"/>.</param>
|
|
<param name="unpacker">The unpacker to be passed to the method.</param>
|
|
<returns>A deserialized value.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackBooleanValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableBoolean(System.Nullable{System.Boolean}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Boolean type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableBooleanValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableBoolean(System.Nullable{System.Boolean}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Boolean type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackByteValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableByte(System.Nullable{System.Byte}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Byte type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableByteValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableByte(System.Nullable{System.Byte}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Byte type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackInt16Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableInt16(System.Nullable{System.Int16}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Int16 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableInt16Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableInt16(System.Nullable{System.Int16}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Int16 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackInt32Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableInt32(System.Nullable{System.Int32}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Int32 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableInt32Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableInt32(System.Nullable{System.Int32}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Int32 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackInt64Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableInt64(System.Nullable{System.Int64}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Int64 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableInt64Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableInt64(System.Nullable{System.Int64}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Int64 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackSByteValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableSByte(System.Nullable{System.SByte}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack SByte type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableSByteValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableSByte(System.Nullable{System.SByte}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack SByte type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackUInt16Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableUInt16(System.Nullable{System.UInt16}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack UInt16 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableUInt16Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableUInt16(System.Nullable{System.UInt16}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack UInt16 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackUInt32Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableUInt32(System.Nullable{System.UInt32}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack UInt32 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableUInt32Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableUInt32(System.Nullable{System.UInt32}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack UInt32 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackUInt64Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableUInt64(System.Nullable{System.UInt64}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack UInt64 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableUInt64Value(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableUInt64(System.Nullable{System.UInt64}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack UInt64 type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackSingleValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableSingle(System.Nullable{System.Single}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Single type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableSingleValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableSingle(System.Nullable{System.Single}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Single type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackDoubleValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableDouble(System.Nullable{System.Double}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Double type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackNullableDoubleValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadNullableDouble(System.Nullable{System.Double}@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack Double type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackStringValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadString(System.String@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack string type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.Serialization.UnpackHelpers.UnpackBinaryValue(MsgPack.Unpacker,System.Type,System.String)">
|
|
<summary>
|
|
Invokes <see cref="M:MsgPack.Unpacker.ReadBinary(System.Byte[]@)"/> and returns its result.
|
|
</summary>
|
|
<param name="unpacker">The unpacker to be used.</param>
|
|
<param name="objectType">The type of the object which is deserializing now.</param>
|
|
<param name="memberName">The name of the member which is deserializing now.</param>
|
|
<returns>The unpacked value.</returns>
|
|
<exception cref="T:System.Runtime.Serialization.SerializationException">
|
|
Failed to unpack byte array type value from underlying stream.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.StreamPacker">
|
|
<summary>
|
|
Basic <see cref="T:MsgPack.Packer"/> implementation using managed <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.SubtreeUnpacker">
|
|
<summary>
|
|
Defines subtree unpacking unpacker.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.TupleItems">
|
|
<summary>
|
|
Defines helper method for items of tuple type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.TupleItems.CreateTupleTypeList(System.Collections.Generic.IList{System.Type})">
|
|
<summary>
|
|
Creates type list for nested tuples.
|
|
</summary>
|
|
<param name="itemTypes">The type list of tuple items, in order.</param>
|
|
<returns>
|
|
The type list for nested tuples.
|
|
The order is from outer to inner.
|
|
</returns>
|
|
</member>
|
|
<member name="T:MsgPack.UnassignedMessageTypeException">
|
|
<summary>
|
|
Represents unpacking error when message type is not valid because 0xC1 will never be assigned.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.UnassignedMessageTypeException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.UnassignedMessageTypeException"/> class with the default error message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.UnassignedMessageTypeException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.UnassignedMessageTypeException"/> class with a specified error message.
|
|
</summary>
|
|
<param name="message">The message that describes the error. </param>
|
|
</member>
|
|
<member name="M:MsgPack.UnassignedMessageTypeException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.UnassignedMessageTypeException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception. </param>
|
|
<param name="inner">
|
|
The exception that is the cause of the current exception, or a <c>null</c> if no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="T:MsgPack.UnpackException">
|
|
<summary>
|
|
Represents generic unpacking error.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackException.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.UnpackException"/> class with the default error message.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.UnpackException"/> class with a specified error message.
|
|
</summary>
|
|
<param name="message">The message that describes the error. </param>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:MsgPack.UnpackException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
|
|
</summary>
|
|
<param name="message">The error message that explains the reason for the exception. </param>
|
|
<param name="inner">
|
|
The exception that is the cause of the current exception, or a <c>null</c> if no inner exception is specified.
|
|
</param>
|
|
</member>
|
|
<member name="T:MsgPack.Unpacking">
|
|
<summary>
|
|
Defines direct conversion value from/to Message Pack binary stream without intermediate <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</summary>
|
|
<remarks>
|
|
This class provides convinient way to unpack objects from wellknown seekable stream.
|
|
This class does not support stream feeding.
|
|
</remarks>
|
|
<seealso cref="T:MsgPack.Unpacker"/>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackByte(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Byte"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Byte"/> which contains unpacked <see cref="T:System.Byte"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Byte"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackByte(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackByte(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Byte"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Byte"/> which contains unpacked <see cref="T:System.Byte"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Byte"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackByte(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Byte"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.Byte"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Byte"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackSByte(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.SByte"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.SByte"/> which contains unpacked <see cref="T:System.SByte"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.SByte"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackSByte(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackSByte(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.SByte"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.SByte"/> which contains unpacked <see cref="T:System.SByte"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.SByte"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackSByte(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.SByte"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.SByte"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.SByte"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt16(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int16"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Int16"/> which contains unpacked <see cref="T:System.Int16"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int16"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackInt16(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt16(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int16"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Int16"/> which contains unpacked <see cref="T:System.Int16"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int16"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt16(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int16"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.Int16"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int16"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt16(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt16"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.UInt16"/> which contains unpacked <see cref="T:System.UInt16"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt16"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackUInt16(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt16(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt16"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.UInt16"/> which contains unpacked <see cref="T:System.UInt16"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt16"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt16(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt16"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.UInt16"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt16"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt32(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int32"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Int32"/> which contains unpacked <see cref="T:System.Int32"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int32"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackInt32(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt32(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int32"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Int32"/> which contains unpacked <see cref="T:System.Int32"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int32"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt32(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int32"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.Int32"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int32"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt32(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt32"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.UInt32"/> which contains unpacked <see cref="T:System.UInt32"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt32"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackUInt32(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt32(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt32"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.UInt32"/> which contains unpacked <see cref="T:System.UInt32"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt32"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt32(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt32"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.UInt32"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt32"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt64(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int64"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Int64"/> which contains unpacked <see cref="T:System.Int64"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int64"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackInt64(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt64(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int64"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Int64"/> which contains unpacked <see cref="T:System.Int64"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int64"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackInt64(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Int64"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.Int64"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Int64"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt64(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt64"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.UInt64"/> which contains unpacked <see cref="T:System.UInt64"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt64"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackUInt64(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt64(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt64"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.UInt64"/> which contains unpacked <see cref="T:System.UInt64"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt64"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackUInt64(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.UInt64"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.UInt64"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.UInt64"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackSingle(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Single"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Single"/> which contains unpacked <see cref="T:System.Single"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Single"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackSingle(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackSingle(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Single"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Single"/> which contains unpacked <see cref="T:System.Single"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Single"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackSingle(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Single"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.Single"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Single"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDouble(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Double"/> value from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Double"/> which contains unpacked <see cref="T:System.Double"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Double"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackDouble(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDouble(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Double"/> value from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Double"/> which contains unpacked <see cref="T:System.Double"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Double"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDouble(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.Double"/> value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.Double"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Double"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackArray(System.Byte[])">
|
|
<summary>
|
|
Unpacks the array from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Collections.Generic.IList`1"/> which contains unpacked the array and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Collections.Generic.IList`1"/>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackArray(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackArray(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks the array from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Collections.Generic.IList`1"/> which contains unpacked the array and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Collections.Generic.IList`1"/>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackArray(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks the array value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked the array value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Collections.Generic.IList`1"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackArrayLength(System.Byte[])">
|
|
<summary>
|
|
Unpacks length of the array from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of nullable <see cref="T:System.Int64"/> which contains unpacked length of the array and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to nullable <see cref="T:System.Int64"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackArrayLength(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackArrayLength(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks length of the array from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of nullable <see cref="T:System.Int64"/> which contains unpacked length of the array and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to nullable <see cref="T:System.Int64"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackArrayLength(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks length of the array value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked length of the array value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to nullable <see cref="T:System.Int64"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDictionary(System.Byte[])">
|
|
<summary>
|
|
Unpacks the dictionary from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:MsgPack.MessagePackObjectDictionary"/> which contains unpacked the dictionary and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackDictionary(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDictionary(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks the dictionary from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:MsgPack.MessagePackObjectDictionary"/> which contains unpacked the dictionary and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDictionary(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks the dictionary value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked the dictionary value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackObjectDictionary"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDictionaryCount(System.Byte[])">
|
|
<summary>
|
|
Unpacks count of the dictionary entries from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of nullable <see cref="T:System.Int64"/> which contains unpacked count of the dictionary entries and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to nullable <see cref="T:System.Int64"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackDictionaryCount(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDictionaryCount(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks count of the dictionary entries from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of nullable <see cref="T:System.Int64"/> which contains unpacked count of the dictionary entries and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to nullable <see cref="T:System.Int64"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackDictionaryCount(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks count of the dictionary entries value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked count of the dictionary entries value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to nullable <see cref="T:System.Int64"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackBinary(System.Byte[])">
|
|
<summary>
|
|
Unpacks the raw binary from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Byte"/>[] which contains unpacked the raw binary and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Byte"/>[].
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackBinary(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackBinary(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks the raw binary from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Byte"/>[] which contains unpacked the raw binary and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Byte"/>[].
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackBinary(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks the raw binary value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked the raw binary value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Byte"/>[].
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackBoolean(System.Byte[])">
|
|
<summary>
|
|
Unpacks the boolean from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Boolean"/> which contains unpacked the boolean and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Boolean"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackBoolean(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackBoolean(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks the boolean from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Boolean"/> which contains unpacked the boolean and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Boolean"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackBoolean(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks the boolean value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked the boolean value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Boolean"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackNull(System.Byte[])">
|
|
<summary>
|
|
Unpacks the nil from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Object"/> which contains unpacked the nil and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Object"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackNull(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackNull(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks the nil from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.Object"/> which contains unpacked the nil and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Object"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackNull(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks the nil value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked the nil value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.Object"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackObject(System.Byte[])">
|
|
<summary>
|
|
Unpacks the <see cref="T:MsgPack.MessagePackObject"/> which represents the value which has MessagePack type semantics. from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:MsgPack.MessagePackObject"/> which contains unpacked the <see cref="T:MsgPack.MessagePackObject"/> which represents the value which has MessagePack type semantics. and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks the <see cref="T:MsgPack.MessagePackObject"/> which represents the value which has MessagePack type semantics. from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:MsgPack.MessagePackObject"/> which contains unpacked the <see cref="T:MsgPack.MessagePackObject"/> which represents the value which has MessagePack type semantics. and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackObject"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks the <see cref="T:MsgPack.MessagePackObject"/> which represents the value which has MessagePack type semantics. value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked the <see cref="T:MsgPack.MessagePackObject"/> which represents the value which has MessagePack type semantics. value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackObject"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackExtendedTypeObject(System.Byte[])">
|
|
<summary>
|
|
Unpacks the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which represents the extended type value. from the head of specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which contains unpacked the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which represents the extended type value. and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackExtendedTypeObject(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackExtendedTypeObject(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which represents the extended type value. from the specified byte array.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which contains unpacked the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which represents the extended type value. and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not grator than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[],System.Int32)"/> instead.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackExtendedTypeObject(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which represents the extended type value. value from the specified <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked the <see cref="T:MsgPack.MessagePackExtendedTypeObject"/> which represents the extended type value. value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:MsgPack.MessagePackExtendedTypeObject"/>.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageNotSupportedException">
|
|
The items count of the underlying collection body is over <see cref="F:System.Int32.MaxValue"/>.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackByteStream(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks raw value from the specified <see cref="T:System.IO.Stream"/> as <see cref="T:MsgPack.UnpackingStream"/>.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingStream"/> which represents raw value stream.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not raw binary.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
<see cref="T:MsgPack.UnpackingStream"/> does not own <paramref name="source"/>, so <paramref name="source"/> still should be closed.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackCharStream(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks raw value from the specified <see cref="T:System.IO.Stream"/> as <see cref="T:MsgPack.UnpackingStreamReader"/> with UTF-8 encoding.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingStreamReader"/> which represents raw value stream as UTF-8 string.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not raw binary.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
if <paramref name="source"/> contains invalid sequence as UTF-8 encoding string,
|
|
the <see cref="T:System.Text.DecoderFallbackException"/> may occurs on read char.
|
|
</para>
|
|
<para>
|
|
<see cref="T:MsgPack.UnpackingStreamReader"/> does not own <paramref name="source"/>, so <paramref name="source"/> still should be closed.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackCharStream(System.IO.Stream,System.Text.Encoding)">
|
|
<summary>
|
|
Unpacks raw value from the specified <see cref="T:System.IO.Stream"/> as <see cref="T:MsgPack.UnpackingStreamReader"/> with specified encoding.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<param name="encoding">The <see cref="T:System.Text.Encoding"/> to decode binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingStreamReader"/> which represents raw value stream as UTF-8 string.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or, <paramref name="encoding"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not raw binary.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
if <paramref name="source"/> contains invalid sequence as specified encoding string,
|
|
the <see cref="T:System.Text.DecoderFallbackException"/> may occurs on read char.
|
|
</para>
|
|
<para>
|
|
<see cref="T:MsgPack.UnpackingStreamReader"/> does not own <paramref name="source"/>, so <paramref name="source"/> still should be closed.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackString(System.Byte[])">
|
|
<summary>
|
|
Unpacks <see cref="T:System.String"/> value from the head of specified byte array with UTF-8 encoding.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.String"/> which contains unpacked <see cref="T:System.String"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.String"/>.
|
|
Or, the unpacked result in the <paramref name="source"/> is invalid as UTF-8 encoded byte stream.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackString(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackString(System.Byte[],System.Text.Encoding)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.String"/> value from the head of specified byte array with specified encoding.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="encoding">The <see cref="T:System.Text.Encoding"/> to decode binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.String"/> which contains unpacked <see cref="T:System.String"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or, <paramref name="encoding"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.String"/>.
|
|
Or, the unpacked result in the <paramref name="source"/> is invalid as UTF-8 encoded byte stream.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackString(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackString(System.Byte[],System.Int32)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.String"/> value from specified offsetted byte array with UTF-8 encoding.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.String"/> which contains unpacked <see cref="T:System.String"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not greater than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.String"/>.
|
|
Or, the unpacked result in the <paramref name="source"/> is invalid as specified encoding byte stream.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackString(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackString(System.Byte[],System.Int32,System.Text.Encoding)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.String"/> value from specified offsetted byte array with specified encoding.
|
|
</summary>
|
|
<param name="source">The byte array which contains Message Pack binary stream.</param>
|
|
<param name="offset">The offset to be unpacking start with.</param>
|
|
<param name="encoding">The <see cref="T:System.Text.Encoding"/> to decode binary stream.</param>
|
|
<returns>
|
|
The <see cref="T:MsgPack.UnpackingResult`1"/> of <see cref="T:System.String"/> which contains unpacked <see cref="T:System.String"/> value and processed bytes count.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or, <paramref name="encoding"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="source"/> is empty.
|
|
Or, the length of <paramref name="source"/> is not greater than <paramref name="offset"/>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> is negative value.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not compatible to <see cref="T:System.String"/>.
|
|
Or, the unpacked result in the <paramref name="source"/> is invalid as specified encoding byte stream.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
Invocation of this method is equivalant to call <see cref="M:MsgPack.Unpacking.UnpackString(System.Byte[],System.Int32)"/> with <c>offset</c> is <c>0</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.Byte[])"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackString(System.IO.Stream)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.String"/> value from the specified <see cref="T:System.IO.Stream"/> with UTF-8 encoding.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.String"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not raw binary.
|
|
Or, the unpacked result in the <paramref name="source"/> is invalid as UTF-8 encoded byte stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.Unpacking.UnpackString(System.IO.Stream,System.Text.Encoding)">
|
|
<summary>
|
|
Unpacks <see cref="T:System.String"/> value from the specified <see cref="T:System.IO.Stream"/> with specified encoding.
|
|
</summary>
|
|
<param name="source">The <see cref="T:System.IO.Stream"/> which contains Message Pack binary stream.</param>
|
|
<param name="encoding">The <see cref="T:System.Text.Encoding"/> to decode binary stream.</param>
|
|
<returns>
|
|
The unpacked <see cref="T:System.String"/> value.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="source"/> is <c>null</c>.
|
|
Or <paramref name="encoding"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
The <see cref="P:Stream.CanRead"/> of <paramref name="source"/> is <c>false</c>.
|
|
</exception>
|
|
<exception cref="T:MsgPack.UnpackException">
|
|
<paramref name="source"/> is not valid MessagePack stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<exception cref="T:MsgPack.MessageTypeException">
|
|
The unpacked result in the <paramref name="source"/> is not raw binary.
|
|
Or, the unpacked result in the <paramref name="source"/> is invalid as specified encoding byte stream.
|
|
Note that the state of <paramref name="source"/> will be unpredictable espicially it is not seekable.
|
|
</exception>
|
|
<remarks>
|
|
<para>
|
|
The processed bytes count can be calculated via <see cref="P:Stream.Position"/> of <paramref name="source"/> when the <see cref="P:Stream.CanSeek"/> is <c>true</c>.
|
|
</para>
|
|
<para>
|
|
When the type of packed value is not known, use <see cref="M:MsgPack.Unpacking.UnpackObject(System.IO.Stream)"/> instead.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="T:MsgPack.UnpackingStream">
|
|
<summary>
|
|
Represents raw binary as read only <see cref="T:System.IO.Stream"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
This object behaves as wrapper of the underlying <see cref="T:System.IO.Stream"/> which contains message pack encoded byte array.
|
|
But, this object does not own the stream, so that stream is not closed when this stream is closed.
|
|
</para>
|
|
<para>
|
|
The value of <see cref="M:Stream.CanSeek"/>, timeout, and async API depends on the underlying stream.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingStream.Read(System.Byte[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
|
|
</summary>
|
|
<param name="buffer">
|
|
An array of bytes. When this method returns,
|
|
the buffer contains the specified byte array with the values between <paramref name="offset"/> and ( <paramref name="offset"/> + <paramref name="count"/> - 1)
|
|
replaced by the bytes read from the current source.
|
|
</param>
|
|
<param name="offset">
|
|
The zero-based byte offset in <paramref name="buffer"/> at which to begin storing the data read from the current stream.
|
|
</param>
|
|
<param name="count">
|
|
The maximum number of bytes to be read from the current stream.
|
|
</param>
|
|
<returns>
|
|
The total number of bytes read into the buffer.
|
|
This can be less than the number of bytes requested if that many bytes are not currently available,
|
|
or zero (0) if the end of the stream has been reached.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentException">
|
|
The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="buffer"/> is <c>null</c>.
|
|
</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="offset"/> or <paramref name="count"/> is negative.
|
|
</exception>
|
|
<exception cref="T:System.IO.IOException">
|
|
An I/O error occurs.
|
|
</exception>
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Methods were called after the stream was closed.
|
|
</exception>
|
|
<remarks>
|
|
<note>
|
|
Arguments might be passed to the underlying <see cref="T:System.IO.Stream"/> without any validation.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingStream.Flush">
|
|
<summary>
|
|
Overrides <see cref="M:Stream.Flush()"/> so that no action is performed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingStream.SetLength(System.Int64)">
|
|
<summary>
|
|
Throws <see cref="T:System.NotSupportedException"/>.
|
|
</summary>
|
|
<param name="value">Never used.</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingStream.Write(System.Byte[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Throws <see cref="T:System.NotSupportedException"/>.
|
|
</summary>
|
|
<param name="buffer">Never used.</param>
|
|
<param name="offset">Never used.</param>
|
|
<param name="count">Never used.</param>
|
|
<exception cref="T:System.NotSupportedException">
|
|
Always thrown.
|
|
</exception>
|
|
</member>
|
|
<member name="P:MsgPack.UnpackingStream.CanRead">
|
|
<summary>
|
|
Gets a value indicating whether the current stream supports reading.
|
|
</summary>
|
|
<value>Always <c>true</c>.</value>
|
|
</member>
|
|
<member name="P:MsgPack.UnpackingStream.CanWrite">
|
|
<summary>
|
|
Gets a value indicating whether the current stream supports writing.
|
|
</summary>
|
|
<value>Always <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:MsgPack.UnpackingStream.Length">
|
|
<summary>
|
|
Gets the length in bytes of the stream.
|
|
</summary>
|
|
<value>
|
|
A long value representing the length of the raw binary length.
|
|
This value must be between 0 and <see cref="F:System.Int32.MaxValue"/>.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Methods were called after the stream was closed.
|
|
</exception>
|
|
<remarks>
|
|
This property never throws <see cref="T:System.NotSupportedException"/> even if <see cref="M:Stream.CanSeek"/> is <c>false</c>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:MsgPack.UnpackingStream.CanTimeout">
|
|
<summary>
|
|
Gets a value that determines whether the current stream can time out.
|
|
</summary>
|
|
<value>
|
|
A value that determines whether the current stream can time out.
|
|
</value>
|
|
<exception cref="T:System.ObjectDisposedException">
|
|
Methods were called after the stream was closed.
|
|
</exception>
|
|
</member>
|
|
<member name="T:MsgPack.UnpackingStreamReader">
|
|
<summary>
|
|
Implements <see cref="T:System.IO.TextReader"/> which reads raw binary <see cref="T:System.IO.Stream"/> with specific <see cref="T:System.Text.Encoding"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:MsgPack.UnpackingStreamReader.ByteLength">
|
|
<summary>
|
|
Gets the length of the underlying raw binary length.
|
|
</summary>
|
|
<value>
|
|
The length of the underlying raw binary length.
|
|
This value will not be negative.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.UnpackingResult`1">
|
|
<summary>
|
|
Represents result of direct conversion from the byte array.
|
|
</summary>
|
|
<typeparam name="T">Type of value.</typeparam>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingResult`1.Equals(System.Object)">
|
|
<summary>
|
|
Compare two instances are equal.
|
|
</summary>
|
|
<param name="obj"><see cref="T:MsgPack.UnpackingResult`1"/> instance.</param>
|
|
<returns>
|
|
If <paramref name="obj"/> is <see cref="T:MsgPack.UnpackingResult`1"/> and its value is equal to this instance, then true.
|
|
Otherwise false.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingResult`1.Equals(MsgPack.UnpackingResult{`0})">
|
|
<summary>
|
|
Compare two instances are equal.
|
|
</summary>
|
|
<param name="other"><see cref="T:MsgPack.UnpackingResult`1"/> instance.</param>
|
|
<returns>
|
|
Whether value of <paramref name="other"/> is equal to this instance or not.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingResult`1.GetHashCode">
|
|
<summary>
|
|
Get hash code of this instance.
|
|
</summary>
|
|
<returns>Hash code of this instance.</returns>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingResult`1.ToString">
|
|
<summary>
|
|
Get string representation of this object.
|
|
</summary>
|
|
<returns>String representation of this object.</returns>
|
|
<remarks>
|
|
<note>
|
|
DO NOT use this value programmically.
|
|
The purpose of this method is informational, so format of this value subject to change.
|
|
</note>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingResult`1.op_Equality(MsgPack.UnpackingResult{`0},MsgPack.UnpackingResult{`0})">
|
|
<summary>
|
|
Compare two instances are equal.
|
|
</summary>
|
|
<param name="left"><see cref="T:MsgPack.UnpackingResult`1"/> instance.</param>
|
|
<param name="right"><see cref="T:MsgPack.UnpackingResult`1"/> instance.</param>
|
|
<returns>
|
|
Whether value of <paramref name="left"/> and <paramref name="right"/> are equal each other or not.
|
|
</returns>
|
|
</member>
|
|
<member name="M:MsgPack.UnpackingResult`1.op_Inequality(MsgPack.UnpackingResult{`0},MsgPack.UnpackingResult{`0})">
|
|
<summary>
|
|
Compare two instances are not equal.
|
|
</summary>
|
|
<param name="left"><see cref="T:MsgPack.UnpackingResult`1"/> instance.</param>
|
|
<param name="right"><see cref="T:MsgPack.UnpackingResult`1"/> instance.</param>
|
|
<returns>
|
|
Whether value of <paramref name="left"/> and <paramref name="right"/> are not equal each other or are equal.
|
|
</returns>
|
|
</member>
|
|
<member name="P:MsgPack.UnpackingResult`1.ReadCount">
|
|
<summary>
|
|
Get read bytes count from input byte array.
|
|
</summary>
|
|
<value>
|
|
Read bytes count from input byte array.
|
|
If this value equals to old offset, then a value of <see cref="P:MsgPack.UnpackingResult`1.Value"/> property is not undifined.
|
|
</value>
|
|
</member>
|
|
<member name="P:MsgPack.UnpackingResult`1.Value">
|
|
<summary>
|
|
Get retrieved value from the byte array.
|
|
</summary>
|
|
<value>
|
|
Retrieved value from the byte array.
|
|
If <see cref="P:MsgPack.UnpackingResult`1.ReadCount"/> equals to old offset, then a value of this property is not undefined.
|
|
</value>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.LockRecursionPolicy">
|
|
<summary>
|
|
System.Threading.LockRecursionPolicy alternative.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.ReaderWriterLockSlim">
|
|
<summary>
|
|
System.Threading.ReaderWriterLockSlim alternative.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SourceLevels">
|
|
<summary>
|
|
System.Diagnostics.SourceLevels alternative.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.SourceSwitch">
|
|
<summary>
|
|
System.Diagnostics.SourceSwitch alternative.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.TraceEventType">
|
|
<summary>
|
|
System.Diagnostics.TraceEventType alternative.
|
|
</summary>
|
|
</member>
|
|
<member name="T:MsgPack.Serialization.TraceSource">
|
|
<summary>
|
|
System.Diagnostics.TraceSource alternative.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|