org.bytedeco.arrow

Class BufferIteratorResult

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.BufferIteratorResult

All Implemented Interfaces:

AutoCloseable

@Name(value="arrow::Result<arrow::Iterator<std::shared_ptr<arrow::Buffer> > >")
 @NoOffset
 @Properties(inherit=arrow.class)
public class BufferIteratorResult
extends Pointer

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
BufferIteratorResult() Constructs a Result object that contains a non-OK status.
BufferIteratorResult(BufferIterator value) Constructs a Result object that contains value.
BufferIteratorResult(long size) Native array allocator.
BufferIteratorResult(Pointer p) Pointer cast constructor.
BufferIteratorResult(Status status) Constructs a Result object with the given non-OK Status object.

Method Summary

Modifier and Type	Method and Description
BufferIterator	access()
boolean	Equals(BufferIteratorResult other) Compare to another Result.
BufferIteratorResult	getPointer(long i)
BufferIterator	MoveValueUnsafe()
BufferIterator	multiply()
boolean	ok() Indicates whether the object contains a T value.
BufferIteratorResult	position(long position)
Status	status() Gets the stored status object, or an OK status if a T value is stored.
BufferIterator	ValueOrDie() Gets a mutable reference to the stored T value.
BufferIterator	ValueUnsafe() Cast the internally stored value to produce a new result or propagate the stored error.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BufferIteratorResult

public BufferIteratorResult(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

BufferIteratorResult

public BufferIteratorResult(long size)

Native array allocator. Access with Pointer.position(long).

BufferIteratorResult

public BufferIteratorResult()

Constructs a Result object that contains a non-OK status. This constructor is marked explicit to prevent attempts to return {} from a function with a return type of, for example, Result<std::vector<int>>. While return {} seems like it would return an empty vector, it will actually invoke the default constructor of Result.

BufferIteratorResult

public BufferIteratorResult(@Const @ByRef
                            Status status)

Constructs a Result object with the given non-OK Status object. All calls to ValueOrDie() on this object will abort. The given status must not be an OK status, otherwise this constructor will abort. This constructor is not declared explicit so that a function with a return type of Result<T> can return a Status object, and the status will be implicitly converted to the appropriate return type as a matter of convenience.

Parameters:

status - The non-OK Status object to initialize to.

BufferIteratorResult

public BufferIteratorResult(@ByRef(value=true)
                            BufferIterator value)

Constructs a Result object that contains value. The resulting object is considered to have an OK status. The wrapped element can be accessed with ValueOrDie(). This constructor is made implicit so that a function with a return type of Result<T> can return an object of type T, implicitly converting it to a Result<T> object.

Parameters:

value - The value to initialize to.

Method Detail

position

public BufferIteratorResult position(long position)

Overrides:

position in class Pointer

getPointer

public BufferIteratorResult getPointer(long i)

Overrides:

getPointer in class Pointer

Equals

@Cast(value="bool")
public boolean Equals(@Const @ByRef
                                           BufferIteratorResult other)

Compare to another Result.

ok

@Cast(value="const bool")
public boolean ok()

Indicates whether the object contains a T value. Generally instead of accessing this directly you will want to use ASSIGN_OR_RAISE defined below.

Returns:

True if this Result object's status is OK (i.e. a call to ok() returns true). If this function returns true, then it is safe to access the wrapped element through a call to ValueOrDie().

status

@Const
 @ByRef
public Status status()

Gets the stored status object, or an OK status if a T value is stored. /** /** @return The stored non-OK status object, or an OK status if this object /** has a value.

ValueOrDie

@ByRef
public BufferIterator ValueOrDie()

Gets a mutable reference to the stored T value. This method should only be called if this Result object's status is OK (i.e. a call to ok() returns true), otherwise this call will abort.

Returns:

The stored T value.

multiply

@ByRef
 @Name(value="operator *")
public BufferIterator multiply()

access

@Name(value="operator ->")
public BufferIterator access()

ValueUnsafe

@Const
 @ByRef
public BufferIterator ValueUnsafe()

Cast the internally stored value to produce a new result or propagate the stored error.

MoveValueUnsafe

@ByVal
public BufferIterator MoveValueUnsafe()