Struct ArrowBuffer

Namespace

Apache.Arrow

Assembly

Apache.Arrow.dll

public readonly struct ArrowBuffer : IEquatable<ArrowBuffer>, IDisposable

Implements

IEquatable<ArrowBuffer>

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ArrowBuffer(ReadOnlyMemory<byte>)

public ArrowBuffer(ReadOnlyMemory<byte> data)

Parameters

data ReadOnlyMemory<byte>

Properties

Empty

public static ArrowBuffer Empty { get; }

Property Value

ArrowBuffer

IsEmpty

public bool IsEmpty { get; }

Property Value

bool

Length

public int Length { get; }

Property Value

int

Memory

public ReadOnlyMemory<byte> Memory { get; }

Property Value

ReadOnlyMemory<byte>

Span

Gets a read-only span over the buffer contents.

public ReadOnlySpan<byte> Span { get; }

Property Value

ReadOnlySpan<byte>

Remarks

CAUTION: The returned ReadOnlySpan points directly to memory managed by this ArrowBuffer. Ensure the ArrowBuffer instance remains rooted and undisposed while using this span to prevent use-after-free.

Methods

Clone(MemoryAllocator)

public ArrowBuffer Clone(MemoryAllocator allocator = null)

Parameters

allocator MemoryAllocator

Returns

ArrowBuffer

Dispose()

public void Dispose()

Equals(ArrowBuffer)

public bool Equals(ArrowBuffer other)

Parameters

other ArrowBuffer

Returns

bool

Retain()

Adds another reference to the memory used by this buffer. Allows a single buffer to be shared by multiple arrays.

public ArrowBuffer Retain()

Returns

ArrowBuffer