blob: cc39ff3cd804f716db050e94db4fee4118729230 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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();
}
}
|
