fuchsia.io/File.GetBackingMemory
METHOD
fuchsia.io
sdk/fidl/fuchsia.io/file.fidl:192
Acquires a [`zx.Handle:VMO`] representing this file, if there is one,
with the requested access rights.
Implementations are not required to implement files backed by VMOs so
this request may fail. Additionally, implementations may only support
a certain subset of the flags. Clients should be prepared with fallback
behavior if this request fails.
If a client specifies neither `PRIVATE_CLONE` nor `SHARED_BUFFER`, the
implementation is free to choose the semantics of the returned VMO.
+ request `flags` a [`VmoFlags`] indicating the desired mode of access.
- response `vmo` the requested [`zx.Handle:VMO`].
* error a [`zx.Status`] value indicating the failure.
This method requires the following rights:
* [`Rights.READ_BYTES`] if `flags` includes [`VmoFlags.READ`].
* [`Rights.WRITE_BYTES`] if `flags` includes [`VmoFlags.WRITE`].
* [`Rights.EXECUTE`] if `flags` includes [`VmoFlags.EXECUTE`].
Relationships
-
ACCEPTS_TYPE→fuchsia.io/flags -
ACCEPTS_TYPE→fuchsia.io/bug -
ACCEPTS_TYPE→fuchsia.io/state -
ACCEPTS_TYPE→fuchsia.io/READ -
ACCEPTS_TYPE→fuchsia.io/WRITE -
ACCEPTS_TYPE→fuchsia.io/EXECUTE -
ACCEPTS_TYPE→fuchsia.io/PRIVATE_CLONE -
ACCEPTS_TYPE→fuchsia.io/SHARED_BUFFER -
RETURNS_TYPE→fuchsia.io/vmo -
RETURNS_TYPE→fuchsia.io/zx -
RETURNS_TYPE→fuchsia.io/Handle -
RETURNS_TYPE→fuchsia.io/VMO
Documentation (1)
-
SUBSTANTIVE
sdk/fidl/fuchsia.io/file.fidl:192↗
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"