fuchsia.io/Writable.Write
METHOD
fuchsia.io
sdk/fidl/fuchsia.io/file.fidl:333
Writes data at the seek offset.
The seek offset is moved forward by the number of bytes written.
If the file is in append mode, the seek offset is first set to the end
of the file, followed by the write, in one atomic step.
The file size may grow if the seek offset plus `data.length` is beyond
the current end of file.
+ request `data` the byte buffer to write to the file.
- response `actual_count` the number of bytes written.
## Invariants
* The returned `actual_count` will never be greater than `data.length`.
* If the server is unable to write all the data due to e.g. not enough
space, `actual_count` may be less than `data.length`. If no bytes
could be written, an error is returned.
* If `data.length` is zero, the server should perform all the checks
ensuring write access without mutating the file and return a
successful write of zero bytes. The seek offset is still updated if
in append mode.
This method requires the [`Rights.WRITE_BYTES`] right.
Relationships
-
ACCEPTS_TYPE→fuchsia.io/data -
ACCEPTS_TYPE→fuchsia.io/Transfer -
RETURNS_TYPE→fuchsia.io/actual_count
Documentation (1)
-
SUBSTANTIVE
sdk/fidl/fuchsia.io/file.fidl:333↗
Tests (0)
No test references.
Examples (0)
No example references.
Gaps
Missing categories:
- examples
- tests
Findings (2)
-
WARNING
DOCUMENTED_UNTESTEDelement is documented but has no test references -
WARNING
MISSING_IN_CATEGORYno references in category "tests.unit_tests"