diff options
Diffstat (limited to 'tensorflow/g3doc/api_docs/cc/ClassRandomAccessFile.md')
-rw-r--r-- | tensorflow/g3doc/api_docs/cc/ClassRandomAccessFile.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/tensorflow/g3doc/api_docs/cc/ClassRandomAccessFile.md b/tensorflow/g3doc/api_docs/cc/ClassRandomAccessFile.md new file mode 100644 index 0000000000..3538c2ca11 --- /dev/null +++ b/tensorflow/g3doc/api_docs/cc/ClassRandomAccessFile.md @@ -0,0 +1,38 @@ +#Class tensorflow::RandomAccessFile + +A file abstraction for randomly reading the contents of a file. + + + +##Member Summary + +* [tensorflow::RandomAccessFile::RandomAccessFile](#tensorflow_RandomAccessFile_RandomAccessFile) +* [virtual tensorflow::RandomAccessFile::~RandomAccessFile](#virtual_tensorflow_RandomAccessFile_RandomAccessFile) +* [virtual Status tensorflow::RandomAccessFile::Read](#virtual_Status_tensorflow_RandomAccessFile_Read) + * Reads up to "n" bytes from the file starting at "offset". + +##Member Details + +#### tensorflow::RandomAccessFile::RandomAccessFile() {#tensorflow_RandomAccessFile_RandomAccessFile} + + + + + +#### virtual tensorflow::RandomAccessFile::~RandomAccessFile() {#virtual_tensorflow_RandomAccessFile_RandomAccessFile} + + + + + +#### virtual Status tensorflow::RandomAccessFile::Read(uint64 offset, size_t n, StringPiece *result, char *scratch) const =0 {#virtual_Status_tensorflow_RandomAccessFile_Read} + +Reads up to "n" bytes from the file starting at "offset". + +"scratch[0..n-1]" may be written by this routine. Sets "*result" to the data that was read (including if fewer than "n" bytes were successfully read). May set "*result" to point at data in "scratch[0..n-1]", so "scratch[0..n-1]" must be live when "*result" is used. + +On OK returned status: "n" bytes have been stored in "*result". On non-OK returned status: [0..n] bytes have been stored in "*result". + +Returns OUT_OF_RANGE if fewer than n bytes were stored in "*result" because of EOF. + +Safe for concurrent use by multiple threads. |