IDisposable helper types.
Disposable/AsyncDisposable- When disposed, invokes anAction/Func<ValueTask>.CollectionDisposable/AsyncCollectionDisposable- When disposed, disposes a collection of other disposables.NoopDisposable- When disposed, does nothing.
The Disposable type wraps an Action, and invokes that Action exactly once when it is disposed. The first thread to call Dispose is the one that invokes the Action; all other threads that call Dispose are blocked until the Action is completed. Once the Action is completed, it is never invoked again; future calls to Disposable.Dispose are no-ops.
You can create a Disposable by calling Disposable.Create(Action) or new Disposable(Action).
AsyncDisposable is exactly the same as Disposable except it wraps a Func<ValueTask>.
If the Action (or Func<Task>) throws an exception, only the first caller of Dispose (or DisposeAsync) will observe the exception. All other calls to Dispose / DisposeAsync will wait for the delegate to complete, but they will not observe the exception.
You can append an Action to a Disposable by calling its Add method with the Action to add. If the Disposable is already disposed (or is in the process of being disposed by another thread), then the additional Action is invoked immediately.
AsyncDisposable may also have multiple delegates. By default, they are all invoked concurrently, but you can change this to serial by creating the instance with the AsyncDisposeFlags.ExecuteSerially flag.
CollectionDisposable contains a collection of IDisposable instances, and disposes them all exactly once when it is disposed. The first thread to call Dispose is the one that disposes all instances; all other threads that call Dispose are blocked until all instances have been disposed. Once disposed, future calls to CollectionDisposable.Dispose are no-ops.
You can create a CollectionDisposable by calling CollectionDisposable.Create(...) or new CollectionDisposable(...), passing the collection of disposables.
You can also append a disposable to the CollectionDisposable by calling its Add method and passing it the disposable. If the CollectionDisposable is already disposed (or is in the process of being disposed by another thread), then the additional disposable is disposed immediately.
AsyncCollectionDisposable is exactly the same as CollectionDisposable except it is a collection of IAsyncDisposable instances. You can also create a mixed collection (containing both IDisposable and IAsyncDisposable instances) by calling ToAsyncDisposable on your IDisposable instances.
By default, all IAsyncDisposable instances are disposed concurrently, but you can change this to serial by creating the AsyncCollectionDisposable instance with the AsyncDisposeFlags.ExecuteSerially flag.
CollectionDisposable can be used as a wrapper to enforce only-dispose-once semantics on another disposable. If a type IncorrectDisposable has a Dispose method that breaks if it is called more than once, then CollectionDisposable.Create(incorrectDisposable) returns an IDisposable that will only invoke IncorrectDisposable.Dispose a single time, regardless of how many times you call CollectionDisposable.Dispose.
A type implementing both IDisposable and IAsyncDisposable that does nothing when disposed.
You can retrieve the singleton instance via NoopDisposable.Instance.
The SingleDisposable<T> type is a base type for disposables that desire exactly-once semantics, blocking other threads calling Dispose until the initial Dispose is complete. Both Disposable and CollectionDisposable inherit from this type.
The type T is an immutable type that represents the contextual state of the instance. It is initialized in the constructor, optionally updated by calling TryUpdateContext, and finally retrieved and passed to Dispose(T) exactly once when Dispose() is called.
When the base type invokes Dispose(T), your derived type should perform whatever disposing logic it needs to.
AsyncSingleDisposable<T> is exactly the same as SingleDisposable<T> except that it implements IAsyncDisposable instead of IDisposable.
If Dispose(T) (or DisposeAsync(T)) throws an exception, only the first caller of Dispose (or DisposeAsync) will observe the exception. All other calls to Dispose / DisposeAsync will wait for the delegate to complete, but they will not observe the exception.
The SingleNonblockingDisposable<T> type is a base type for disposables that desire exactly-once semantics without blocking other threads calling Dispose. It works exactly like SingleDisposable<T>, except that once disposal has started, other threads calling Dispose will return immediately, treating the additional Dispose calls as a no-op.
AsyncSingleNonblockingDisposable<T> is exactly the same as SingleNonblockingDisposable<T> except that it implements IAsyncDisposable instead of IDisposable.