Class ScyllaDequeDOTS<T>.Builder

Fluent builder for configuring and constructing ScyllaDequeDOTS<T> instances.

Inheritance
object
ScyllaDequeDOTS<T>.Builder
Inherited Members
Namespace: Scylla.Core.Structures
Assembly: ScyllaCore.dll
Syntax
public sealed class ScyllaDequeDOTS<T>.Builder
Remarks

Obtain a builder by calling CreateBuilder(). Chain configuration methods and finish with Build() or BuildConcrete() (both return the concrete ScyllaDequeDOTS<T> struct since no synchronized wrapper exists for DOTS types). WithAllocator(Allocator) is mandatory; all other configuration methods are optional.

Methods

Build()

Constructs and returns the configured ScyllaDequeDOTS<T> instance.

Declaration
public ScyllaDequeDOTS<T> Build()
Returns
Type Description
ScyllaDequeDOTS<T>

A fully initialized ScyllaDequeDOTS<T> ready for use.
Remarks

The caller is responsible for disposing the returned instance. Because ScyllaDequeDOTS<T> does not have a synchronized wrapper, this method and BuildConcrete() are functionally identical.

Exceptions
Type Condition
InvalidOperationException

Thrown when WithAllocator(Allocator) has not been called before this method. An allocator is required to allocate the internal Unity.Collections.NativeArray<T> buffer.

BuildConcrete()

Constructs and returns the configured ScyllaDequeDOTS<T> instance. Functionally identical to Build() since ScyllaDequeDOTS<T> has no synchronized wrapper variant.

Declaration
public ScyllaDequeDOTS<T> BuildConcrete()
Returns
Type Description
ScyllaDequeDOTS<T>

A fully initialized ScyllaDequeDOTS<T> ready for use.
Remarks

This method exists for API consistency with other Scylla collection builders (such as the managed ScyllaDeque<T>.Builder) that distinguish between Build() (returns interface) and BuildConcrete() (returns concrete type). For DOTS collections there is no interface-returning variant, so both methods behave identically.

Exceptions
Type Condition
InvalidOperationException

Thrown when WithAllocator(Allocator) has not been called before this method.

OverwriteOnFull(bool)

Enables or disables overwrite-on-full behavior on the deque being built. When enabled, pushing onto a full deque evicts the element at the opposite end rather than returning false (push-front evicts back, push-back evicts front).

Declaration
public ScyllaDequeDOTS<T>.Builder OverwriteOnFull(bool value = true)
Parameters
Type Name Description
bool value

true (the default when this overload is called without arguments) to enable overwrite-on-full; false to have full-deque pushes fail silently.
Returns
Type Description
ScyllaDequeDOTS<T>.Builder

This builder instance for method chaining.

WithAllocator(Allocator)

Sets the memory allocator for the internal Unity.Collections.NativeArray<T> buffer. This method must be called before Build() or BuildConcrete().

Declaration
public ScyllaDequeDOTS<T>.Builder WithAllocator(Allocator allocator)
Parameters
Type Name Description
Allocator allocator

The Unity Unity.Collections.Allocator to use. Must not be Unity.Collections.Allocator.None.

  • Unity.Collections.Allocator.Persistent: recommended for long-lived deques that survive across multiple frames.
  • Unity.Collections.Allocator.TempJob: use for deques passed into jobs that complete within four frames.
  • Unity.Collections.Allocator.Temp: use for very short-lived deques that are created and disposed within a single frame or method.
Returns
Type Description
ScyllaDequeDOTS<T>.Builder

This builder instance for method chaining.
Exceptions
Type Condition
ArgumentException

Thrown when allocator is Unity.Collections.Allocator.None.

WithCapacity(int)

Sets the fixed capacity of the deque's backing native buffer.

Declaration
public ScyllaDequeDOTS<T>.Builder WithCapacity(int capacity)
Parameters
Type Name Description
int capacity

The desired fixed capacity. Must be 0 or greater; negative values are rejected. Values of 0 are permitted here but will be clamped to 1 during construction.
Returns
Type Description
ScyllaDequeDOTS<T>.Builder

This builder instance for method chaining.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown when capacity is negative.

WithNativeArrayOptions(NativeArrayOptions)

Sets the Unity.Collections.NativeArrayOptions used when allocating the internal buffer. Controls whether the memory is zero-initialized at allocation time.

Declaration
public ScyllaDequeDOTS<T>.Builder WithNativeArrayOptions(NativeArrayOptions options)
Parameters
Type Name Description
NativeArrayOptions options

Unity.Collections.NativeArrayOptions.UninitializedMemory (default) for maximum allocation performance; Unity.Collections.NativeArrayOptions.ClearMemory to zero-initialize the buffer at allocation time (required when inspecting unwritten slots before any pushes).
Returns
Type Description
ScyllaDequeDOTS<T>.Builder

This builder instance for method chaining.

Extension Methods