Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Public Member Functions | Friends | List of all members
arrow::io::HdfsReadableFile Class Reference

#include <arrow/io/hdfs.h>

Inheritance diagram for arrow::io::HdfsReadableFile:
arrow::io::RandomAccessFile arrow::io::InputStream arrow::io::Seekable arrow::io::FileInterface arrow::io::Readable

Public Member Functions

 ~HdfsReadableFile ()
 
Status Close () override
 
Status GetSize (int64_t *size) override
 
Status Read (int64_t nbytes, int64_t *bytes_read, uint8_t *buffer) override
 
Status Read (int64_t nbytes, std::shared_ptr< Buffer > *out) override
 
Status ReadAt (int64_t position, int64_t nbytes, int64_t *bytes_read, uint8_t *buffer) override
 Read nbytes at position, provide default implementations using Read(...), but can be overridden. More...
 
Status ReadAt (int64_t position, int64_t nbytes, std::shared_ptr< Buffer > *out) override
 Read nbytes at position, provide default implementations using Read(...), but can be overridden. More...
 
bool supports_zero_copy () const override
 
Status Seek (int64_t position) override
 
Status Tell (int64_t *position) const override
 
void set_memory_pool (MemoryPool *pool)
 
- Public Member Functions inherited from arrow::io::RandomAccessFile
 ~RandomAccessFile () override
 Necessary because we hold a std::unique_ptr. More...
 
- Public Member Functions inherited from arrow::io::FileInterface
virtual ~FileInterface ()=0
 
FileMode::type mode () const
 
- Public Member Functions inherited from arrow::io::Readable
virtual ~Readable ()=default
 
- Public Member Functions inherited from arrow::io::Seekable
virtual ~Seekable ()=default
 

Friends

class HadoopFileSystem::HadoopFileSystemImpl
 

Additional Inherited Members

- Protected Member Functions inherited from arrow::io::RandomAccessFile
 RandomAccessFile ()
 
- Protected Member Functions inherited from arrow::io::InputStream
 InputStream ()=default
 
- Protected Member Functions inherited from arrow::io::FileInterface
 FileInterface ()
 
void set_mode (FileMode::type mode)
 
- Protected Attributes inherited from arrow::io::FileInterface
FileMode::type mode_
 

Constructor & Destructor Documentation

◆ ~HdfsReadableFile()

arrow::io::HdfsReadableFile::~HdfsReadableFile ( )

Member Function Documentation

◆ Close()

Status arrow::io::HdfsReadableFile::Close ( )
overridevirtual

◆ GetSize()

Status arrow::io::HdfsReadableFile::GetSize ( int64_t *  size)
overridevirtual

◆ Read() [1/2]

Status arrow::io::HdfsReadableFile::Read ( int64_t  nbytes,
int64_t *  bytes_read,
uint8_t *  buffer 
)
overridevirtual

Implements arrow::io::Readable.

◆ Read() [2/2]

Status arrow::io::HdfsReadableFile::Read ( int64_t  nbytes,
std::shared_ptr< Buffer > *  out 
)
overridevirtual

Implements arrow::io::Readable.

◆ ReadAt() [1/2]

Status arrow::io::HdfsReadableFile::ReadAt ( int64_t  position,
int64_t  nbytes,
int64_t *  bytes_read,
uint8_t *  out 
)
overridevirtual

Read nbytes at position, provide default implementations using Read(...), but can be overridden.

Default implementation is thread-safe.

Note
Child classes must explicitly call this implementation or provide their own.
Parameters
[in]positionWhere to read bytes from
[in]nbytesThe number of bytes to read
[out]bytes_readThe number of bytes read
[out]outThe buffer to read bytes into
Returns
Status

Implements arrow::io::RandomAccessFile.

◆ ReadAt() [2/2]

Status arrow::io::HdfsReadableFile::ReadAt ( int64_t  position,
int64_t  nbytes,
std::shared_ptr< Buffer > *  out 
)
overridevirtual

Read nbytes at position, provide default implementations using Read(...), but can be overridden.

Default implementation is thread-safe.

Note
Child classes must explicitly call this implementation or provide their own.
Parameters
[in]positionWhere to read bytes from
[in]nbytesThe number of bytes to read
[out]outThe buffer to read bytes into. The number of bytes read can be retrieved by calling Buffer::size().

Implements arrow::io::RandomAccessFile.

◆ Seek()

Status arrow::io::HdfsReadableFile::Seek ( int64_t  position)
overridevirtual

Implements arrow::io::Seekable.

◆ set_memory_pool()

void arrow::io::HdfsReadableFile::set_memory_pool ( MemoryPool pool)

◆ supports_zero_copy()

bool arrow::io::HdfsReadableFile::supports_zero_copy ( ) const
overridevirtual

◆ Tell()

Status arrow::io::HdfsReadableFile::Tell ( int64_t *  position) const
overridevirtual

Friends And Related Function Documentation

◆ HadoopFileSystem::HadoopFileSystemImpl

friend class HadoopFileSystem::HadoopFileSystemImpl
friend

The documentation for this class was generated from the following file: