WriteAccessRequiredAttribute

Description

Used in conjunction with the ReadOnlyAttribute, WriteAccessRequiredAttribute lets you specify which struct method and property require write access to be invoked.

When adding the ReadOnly attribute on a native container, you are indicating that only operations that read data can be performed on this container. When this is the case, methods and properties on the container that modify the array cannot be used. The WriteAccessRequired attribute indicates which methods and properties cannot be used on a container annotated with ReadOnly.

using Unity.Collections.LowLevel.Unsafe;
using Unity.Collections;
using UnityEngine;

[NativeContainer]
public struct MyList<T> where T : struct
{
    public int Length { get; private set; }

    [WriteAccessRequired]
    public void Grow(int capacity)
    {
        // ...
    }
}

public class MyMonoBehaviour : MonoBehaviour
{
    [ReadOnly]
    MyList<int> readOnlyList;

    MyList<int> writableList = new MyList<int>();

    public void OnUpdate()
    {
        writableList.Grow(10); // Ok
        readOnlyList.Grow(10); // Illegal
    }
}