org.bytedeco.arrow

Class ReadableFile

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.arrow.FileInterface

org.bytedeco.arrow.InputStream

org.bytedeco.arrow.RandomAccessFile

org.bytedeco.arrow.ReadableFileRandomAccessFileConcurrencyWrapper

org.bytedeco.arrow.ReadableFile

All Implemented Interfaces:

AutoCloseable

@Namespace(value="arrow::io")
 @NoOffset
 @Properties(inherit=arrow.class)
public class ReadableFile
extends ReadableFileRandomAccessFileConcurrencyWrapper

\brief An operating system file open in read-only mode. Reads through this implementation are unbuffered. If many small reads need to be issued, it is recommended to use a buffering layer for good performance.

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
ReadableFile(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
boolean	closed() \brief Return whether the stream is closed
int	file_descriptor()
static ReadableFileResult	Open(BytePointer path)
static ReadableFileResult	Open(BytePointer path, MemoryPool pool)
static ReadableFileResult	Open(int fd)
static ReadableFileResult	Open(int fd, MemoryPool pool) \brief Open a local file for reading
static ReadableFileResult	Open(String path)
static ReadableFileResult	Open(String path, MemoryPool pool) \brief Open a local file for reading
Status	WillNeed(ReadRange ranges) EXPERIMENTAL: Inform that the given ranges may be read soon.

Methods inherited from class org.bytedeco.arrow.ReadableFileRandomAccessFileConcurrencyWrapper

Abort, Close, GetSize, Peek, Read, Read, ReadAt, ReadAt, Seek, Tell

Methods inherited from class org.bytedeco.arrow.RandomAccessFile

asSeekable, asSeekable, GetStream

Methods inherited from class org.bytedeco.arrow.InputStream

Advance, asReadable, asReadable, ReadMetadata, ReadMetadataAsync, ReadMetadataAsync, supports_zero_copy

Methods inherited from class org.bytedeco.arrow.FileInterface

mode

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, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, 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

ReadableFile

public ReadableFile(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Open

@ByVal
public static ReadableFileResult Open(@StdString
                                              String path,
                                              MemoryPool pool)

\brief Open a local file for reading

Parameters:

path - [in] with UTF8 encoding

pool - [in] a MemoryPool for memory allocations

Returns:

ReadableFile instance

Open

@ByVal
public static ReadableFileResult Open(@StdString
                                              String path)

Open

@ByVal
public static ReadableFileResult Open(@StdString
                                              BytePointer path,
                                              MemoryPool pool)

Open

@ByVal
public static ReadableFileResult Open(@StdString
                                              BytePointer path)

Open

@ByVal
public static ReadableFileResult Open(int fd,
                                              MemoryPool pool)

\brief Open a local file for reading

Parameters:

fd - [in] file descriptor

pool - [in] a MemoryPool for memory allocations

Returns:

ReadableFile instance The file descriptor becomes owned by the ReadableFile, and will be closed on Close() or destruction.

Open

@ByVal
public static ReadableFileResult Open(int fd)

closed

@Cast(value="bool")
public boolean closed()

Description copied from class: FileInterface

\brief Return whether the stream is closed

Overrides:

closed in class FileInterface

file_descriptor

public int file_descriptor()

WillNeed

@ByVal
public Status WillNeed(@StdVector
                               ReadRange ranges)

Description copied from class: RandomAccessFile

EXPERIMENTAL: Inform that the given ranges may be read soon. Some implementations might arrange to prefetch some of the data. However, no guarantee is made and the default implementation does nothing. For robust prefetching, use ReadAt() or ReadAsync().

Overrides:

WillNeed in class RandomAccessFile