diff options
Diffstat (limited to 'src/libraries/Common/tests/TestUtilities/System/Buffers/BoundedMemory.cs')
-rw-r--r-- | src/libraries/Common/tests/TestUtilities/System/Buffers/BoundedMemory.cs | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/src/libraries/Common/tests/TestUtilities/System/Buffers/BoundedMemory.cs b/src/libraries/Common/tests/TestUtilities/System/Buffers/BoundedMemory.cs new file mode 100644 index 00000000000..cc39ff3cd80 --- /dev/null +++ b/src/libraries/Common/tests/TestUtilities/System/Buffers/BoundedMemory.cs @@ -0,0 +1,49 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +namespace System.Buffers +{ + /// <summary> + /// Represents a region of native memory. The <see cref="Memory"/> property can be used + /// to get a <see cref="Memory{Byte}"/> backed by this memory region. + /// </summary> + public abstract class BoundedMemory<T> : IDisposable where T : unmanaged + { + /// <summary> + /// Returns a value stating whether this native memory block is readonly. + /// </summary> + public abstract bool IsReadonly { get; } + + /// <summary> + /// Gets the <see cref="Memory{Byte}"/> which represents this native memory. + /// This <see cref="BoundedMemory{T}"/> instance must be kept alive while working with the <see cref="Memory{Byte}"/>. + /// </summary> + public abstract Memory<T> Memory { get; } + + /// <summary> + /// Gets the <see cref="Span{Byte}"/> which represents this native memory. + /// This <see cref="BoundedMemory{T}"/> instance must be kept alive while working with the <see cref="Span{Byte}"/>. + /// </summary> + public abstract Span<T> Span { get; } + + /// <summary> + /// Disposes this <see cref="BoundedMemory{T}"/> instance. + /// </summary> + public abstract void Dispose(); + + /// <summary> + /// Sets this native memory block to be readonly. Writes to this block will cause an AV. + /// This method has no effect if the memory block is zero length or if the underlying + /// OS does not support marking the memory block as readonly. + /// </summary> + public abstract void MakeReadonly(); + + /// <summary> + /// Sets this native memory block to be read+write. + /// This method has no effect if the memory block is zero length or if the underlying + /// OS does not support marking the memory block as read+write. + /// </summary> + public abstract void MakeWriteable(); + } +}
\ No newline at end of file |