fuchsia.io/File.Read — fuchsia

`fuchsia.io/File.Read`

METHOD fuchsia.io sdk/fidl/fuchsia.io/file.fidl:301

Reads up to 'count' bytes at the seek offset. The seek offset is moved forward by the number of bytes read. ## Invariants * The returned `data.length` will never be greater than `count`. * If `data.length` is less than `count`, it means that the seek offset has reached the end of file as part of this operation. * If `data.length` is zero while `count` is not, it means that the seek offset is already at or beyond the end of file, and no data could be read. * If `count` is zero, the server should perform all the checks ensuring read access without actually read anything, and return an empty `data` vector. This method requires the [`Rights.READ_BYTES`] right. Returns `ZX_ERR_OUT_OF_RANGE` if `count` is greater than `MAX_TRANSFER_SIZE`.

Relationships

INHERITED_FROM → fuchsia.io/Readable.Read
inherited via composition

Documentation (0)

No documentation references.

Tests (3)

tests.unit PseudoFile.ReadBuffered
gtest · src/storage/lib/vfs/cpp/tests/pseudo_file_tests.cc:373
tests.unit PseudoFile.ReadUnbuffered
gtest · src/storage/lib/vfs/cpp/tests/pseudo_file_tests.cc:427
tests.unit VmoFile.Read
gtest · src/storage/lib/vfs/cpp/tests/vmo_file_tests.cc:152

Examples (0)

No example references.

Gaps

Missing categories:

docs.reference
examples

Findings (1)

INFO TESTED_UNDOCUMENTED element has tests but no documentation reference
analyzer: tested-undocumented

← back to elements