Class BinaryArray.BuilderBase<TArray, TBuilder>

Namespace

Apache.Arrow

Assembly

Apache.Arrow.dll

public abstract class BinaryArray.BuilderBase<TArray, TBuilder> : IArrowArrayBuilder<byte, TArray, TBuilder>, IArrowArrayBuilder<TArray, TBuilder>, IArrowArrayBuilder<TArray>, IArrowArrayBuilder where TArray : IArrowArray where TBuilder : class, IArrowArrayBuilder<byte, TArray, TBuilder>

Type Parameters

TArray

TBuilder

Inheritance

object

BinaryArray.BuilderBase<TArray, TBuilder>

Implements

IArrowArrayBuilder<byte, TArray, TBuilder>

IArrowArrayBuilder<TArray, TBuilder>

IArrowArrayBuilder<TArray>

IArrowArrayBuilder

Derived

BinaryArray.Builder

StringArray.Builder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BuilderBase(IArrowType)

protected BuilderBase(IArrowType dataType)

Parameters

dataType IArrowType

Properties

DataType

protected IArrowType DataType { get; }

Property Value

IArrowType

Instance

protected TBuilder Instance { get; }

Property Value

TBuilder

Length

Gets the length of the array built so far.

public int Length { get; }

Property Value

int

NullCount

protected int NullCount { get; }

Property Value

int

Offset

protected int Offset { get; set; }

Property Value

int

ValidityBuffer

protected ArrowBuffer.BitmapBuilder ValidityBuffer { get; }

Property Value

ArrowBuffer.BitmapBuilder

ValueBuffer

protected ArrowBuffer.Builder<byte> ValueBuffer { get; }

Property Value

ArrowBuffer.Builder<byte>

ValueOffsets

protected ArrowBuffer.Builder<int> ValueOffsets { get; }

Property Value

ArrowBuffer.Builder<int>

Methods

AdvanceValueBuffer(int)

Commits bytes previously written into the span returned by GetValueBufferSpan(int).

protected void AdvanceValueBuffer(int count)

Parameters

count int

The number of bytes written to the span returned by the latest GetValueBufferSpan(int) call.

Append(byte)

Appends a value, consisting of a single byte, to the array.

public TBuilder Append(byte value)

Parameters

value byte

Byte value to append.

Returns

TBuilder

Returns the builder (for fluent-style composition).

Append(IEnumerable<byte>)

Append a value, consisting of an enumerable collection of bytes, to the array.

public TBuilder Append(IEnumerable<byte> value)

Parameters

value IEnumerable<byte>

Enumerable collection of bytes to add.

Returns

TBuilder

Returns the builder (for fluent-style composition).

Remarks

Note that this method appends a single value, which may consist of arbitrarily many bytes. If multiple values are to be added, use the AppendRange(IEnumerable<byte>) method instead.

Append(ReadOnlySpan<byte>)

Append a value, consisting of a span of bytes, to the array.

public TBuilder Append(ReadOnlySpan<byte> span)

Parameters

span ReadOnlySpan<byte>

Span of bytes to add.

Returns

TBuilder

Returns the builder (for fluent-style composition).

Remarks

Note that a single value is added, which consists of arbitrarily many bytes. If multiple values are to be added, use the AppendRange(IEnumerable<byte>) method.

AppendNull()

Append a single null value to the array.

public TBuilder AppendNull()

Returns

TBuilder

Returns the builder (for fluent-style composition).

AppendRange(IEnumerable<byte[]>)

Append an enumerable collection of values to the array.

public TBuilder AppendRange(IEnumerable<byte[]> values)

Parameters

values IEnumerable<byte[]>

Values to add.

Returns

TBuilder

Returns the builder (for fluent-style composition).

AppendRange(IEnumerable<byte>)

Append an enumerable collection of single-byte values to the array.

public TBuilder AppendRange(IEnumerable<byte> values)

Parameters

values IEnumerable<byte>

Single-byte values to add.

Returns

TBuilder

Returns the builder (for fluent-style composition).

Remarks

Note that this method appends multiple values, each of which is a single byte. If a single value is to be added, use the Append(IEnumerable<byte>) method instead.

Build(ArrayData)

protected abstract TArray Build(ArrayData data)

Parameters

data ArrayData

Returns

TArray

Build(MemoryAllocator)

Build an Arrow array from the appended contents so far.

public TArray Build(MemoryAllocator allocator = null)

Parameters

allocator MemoryAllocator

Optional memory allocator.

Returns

TArray

Returns an array of type TArray.

Clear()

Clear all contents appended so far.

public TBuilder Clear()

Returns

TBuilder

Returns the builder (for fluent-style composition).

GetValueBufferSpan(int)

Returns writable value-buffer space without changing the committed buffer length.

protected Span<byte> GetValueBufferSpan(int sizeHint)

Parameters

sizeHint int

The minimum number of writable bytes required.

Returns

Span<byte>

A span starting at the first uncommitted byte in the value buffer.

Reserve(int)

public TBuilder Reserve(int capacity)

Parameters

capacity int

Returns

TBuilder

Resize(int)

public TBuilder Resize(int length)

Parameters

length int

Returns

TBuilder

Set(int, byte)

public TBuilder Set(int index, byte value)

Parameters

index int

value byte

Returns

TBuilder

Swap(int, int)

public TBuilder Swap(int i, int j)

Parameters

i int

j int

Returns

TBuilder