- <member name="M:System.IO.UnmanagedMemoryStream.Flush">
- <summary>Overrides the <see cref="M:System.IO.Stream.Flush" /> method so that no action is performed.</summary>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.FlushAsync(System.Threading.CancellationToken)">
- <summary>Overrides the <see cref="M:System.IO.Stream.FlushAsync(System.Threading.CancellationToken)" /> method so that the operation is cancelled if specified, but no other action is performed.</summary>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
- <returns>A task that represents the asynchronous flush operation.</returns>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.Initialize(System.Byte*,System.Int64,System.Int64,System.IO.FileAccess)">
- <summary>Initializes a new instance of the <see cref="T:System.IO.UnmanagedMemoryStream" /> class by using a pointer to an unmanaged memory location.</summary>
- <param name="pointer">A pointer to an unmanaged memory location.</param>
- <param name="length">The length of the memory to use.</param>
- <param name="capacity">The total amount of memory assigned to the stream.</param>
- <param name="access">One of the <see cref="T:System.IO.FileAccess" /> values.</param>
- <exception cref="T:System.Security.SecurityException">The user does not have the required permission.</exception>
- <exception cref="T:System.ArgumentNullException">The <paramref name="pointer" /> value is <see langword="null" />.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="length" /> value is less than zero.
--or-
-The <paramref name="capacity" /> value is less than zero.
--or-
-The <paramref name="length" /> value is large enough to cause an overflow.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.Initialize(System.Runtime.InteropServices.SafeBuffer,System.Int64,System.Int64,System.IO.FileAccess)">
- <summary>Initializes a new instance of the <see cref="T:System.IO.UnmanagedMemoryStream" /> class in a safe buffer with a specified offset, length, and file access.</summary>
- <param name="buffer">The buffer to contain the unmanaged memory stream.</param>
- <param name="offset">The byte position in the buffer at which to start the unmanaged memory stream.</param>
- <param name="length">The length of the unmanaged memory stream.</param>
- <param name="access">The mode of file access to the unmanaged memory stream.</param>
- </member>
- <member name="P:System.IO.UnmanagedMemoryStream.Length">
- <summary>Gets the length of the data in a stream.</summary>
- <returns>The length of the data in the stream.</returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- </member>
- <member name="P:System.IO.UnmanagedMemoryStream.Position">
- <summary>Gets or sets the current position in a stream.</summary>
- <returns>The current position in the stream.</returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The position is set to a value that is less than zero, or the position is larger than <see cref="F:System.Int32.MaxValue" /> or results in overflow when added to the current pointer.</exception>
- </member>
- <member name="P:System.IO.UnmanagedMemoryStream.PositionPointer">
- <summary>Gets or sets a byte pointer to a stream based on the current position in the stream.</summary>
- <returns>A byte pointer.</returns>
- <exception cref="T:System.IndexOutOfRangeException">The current position is larger than the capacity of the stream.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The position is being set is not a valid position in the current stream.</exception>
- <exception cref="T:System.IO.IOException">The pointer is being set to a lower value than the starting position of the stream.</exception>
- <exception cref="T:System.NotSupportedException">The stream was initialized for use with a <see cref="T:System.Runtime.InteropServices.SafeBuffer" />. The <see cref="P:System.IO.UnmanagedMemoryStream.PositionPointer" /> property is valid only for streams that are initialized with a <see cref="T:System.Byte" /> pointer.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.Read(System.Byte[],System.Int32,System.Int32)">
- <summary>Reads the specified number of bytes into the specified array.</summary>
- <param name="buffer">When this method returns, 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. This parameter is passed uninitialized.</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 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.ObjectDisposedException">The stream is closed.</exception>
- <exception cref="T:System.NotSupportedException">The underlying memory does not support reading.
--or-
-The <see cref="P:System.IO.UnmanagedMemoryStream.CanRead" /> property is set to <see langword="false" />.</exception>
- <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> parameter is set to <see langword="null" />.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> parameter is less than zero.
--or-
-The <paramref name="count" /> parameter is less than zero.</exception>
- <exception cref="T:System.ArgumentException">The length of the buffer array minus the <paramref name="offset" /> parameter is less than the <paramref name="count" /> parameter.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.Read(System.Span{System.Byte})">
- <summary>Reads all the bytes of this unmanaged memory stream into the specified span of bytes.</summary>
- <param name="destination">When this method returns, this span contains all the bytes from the unmanaged memory stream.</param>
- <returns>The total number of bytes read into the destination.</returns>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>Asynchronously reads the specified number of bytes into the specified array.</summary>
- <param name="buffer">The buffer to write the data into.</param>
- <param name="offset">The byte offset in <paramref name="buffer" /> at which to begin writing data from the stream.</param>
- <param name="count">The maximum number of bytes to read.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
- <returns>A task that represents the asynchronous read operation. The value of the <paramref name="TResult" /> parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.</returns>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
- <summary>Asynchronously reads the unmanaged memory stream bytes into the memory region.</summary>
- <param name="buffer">When the asynchronous method finishes, this memory region contains all the bytes read from the unmanaged memory stream.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
- <returns>A task that represents the asynchronous read operation, and wraps the total number of bytes read into the buffer.</returns>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.ReadByte">
- <summary>Reads a byte from a stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.</summary>
- <returns>The unsigned byte cast to an <see cref="T:System.Int32" /> object, or -1 if at the end of the stream.</returns>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- <exception cref="T:System.NotSupportedException">The underlying memory does not support reading.
--or-
-The current position is at the end of the stream.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.Seek(System.Int64,System.IO.SeekOrigin)">
- <summary>Sets the current position of the current stream to the given value.</summary>
- <param name="offset">The point relative to <c>origin</c> to begin seeking from.</param>
- <param name="loc">Specifies the beginning, the end, or the current position as a reference point for <c>origin</c>, using a value of type <see cref="T:System.IO.SeekOrigin" />.</param>
- <returns>The new position in the stream.</returns>
- <exception cref="T:System.IO.IOException">An attempt was made to seek before the beginning of the stream.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> value is larger than the maximum size of the stream.</exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="loc" /> is invalid.</exception>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.SetLength(System.Int64)">
- <summary>Sets the length of a stream to a specified value.</summary>
- <param name="value">The length of the stream.</param>
- <exception cref="T:System.IO.IOException">An I/O error has occurred.</exception>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- <exception cref="T:System.NotSupportedException">The underlying memory does not support writing.
--or-
-An attempt is made to write to the stream and the <see cref="P:System.IO.UnmanagedMemoryStream.CanWrite" /> property is <see langword="false" />.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The specified <paramref name="value" /> exceeds the capacity of the stream.
--or-
-The specified <paramref name="value" /> is negative.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.Write(System.Byte[],System.Int32,System.Int32)">
- <summary>Writes a block of bytes to the current stream using data from a buffer.</summary>
- <param name="buffer">The byte array from which to copy bytes to the current stream.</param>
- <param name="offset">The offset in the buffer at which to begin copying bytes to the current stream.</param>
- <param name="count">The number of bytes to write to the current stream.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- <exception cref="T:System.NotSupportedException">The underlying memory does not support writing.
--or-
-An attempt is made to write to the stream and the <see cref="P:System.IO.UnmanagedMemoryStream.CanWrite" /> property is <see langword="false" />.
--or-
-The <paramref name="count" /> value is greater than the capacity of the stream.
--or-
-The position is at the end of the stream capacity.</exception>
- <exception cref="T:System.IO.IOException">An I/O error occurs.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">One of the specified parameters is less than zero.</exception>
- <exception cref="T:System.ArgumentException">The <paramref name="offset" /> parameter minus the length of the <paramref name="buffer" /> parameter is less than the <paramref name="count" /> parameter.</exception>
- <exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> parameter is <see langword="null" />.</exception>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.Write(System.ReadOnlySpan{System.Byte})">
- <summary>Writes a block of bytes to the current unmanaged memory stream using data from the provided span of bytes.</summary>
- <param name="source">The span of bytes from which to copy bytes to the current unmanaged memory stream.</param>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
- <summary>Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.</summary>
- <param name="buffer">The buffer to write data from.</param>
- <param name="offset">The zero-based byte offset in <paramref name="buffer" /> from which to begin copying bytes to the stream.</param>
- <param name="count">The maximum number of bytes to write.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
- <summary>Asynchronously writes a span of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.</summary>
- <param name="buffer">The buffer to write data from.</param>
- <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
- <returns>A task that represents the asynchronous write operation.</returns>
- </member>
- <member name="M:System.IO.UnmanagedMemoryStream.WriteByte(System.Byte)">
- <summary>Writes a byte to the current position in the file stream.</summary>
- <param name="value">A byte value written to the stream.</param>
- <exception cref="T:System.ObjectDisposedException">The stream is closed.</exception>
- <exception cref="T:System.NotSupportedException">The underlying memory does not support writing.
--or-
-An attempt is made to write to the stream and the <see cref="P:System.IO.UnmanagedMemoryStream.CanWrite" /> property is <see langword="false" />.
--or-
-The current position is at the end of the capacity of the stream.</exception>
- <exception cref="T:System.IO.IOException">The supplied <paramref name="value" /> causes the stream exceed its maximum capacity.</exception>