Merge pull request tock#3861 from tyler-potyondy/grant-processbuffer

Get Process Buffer API
YoeDistro · Mar 8, 2024 · d2e7618 · d2e7618
2 parents 01918fa + 6b1acbd
commit d2e7618
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/kernel/src/grant.rs b/kernel/src/grant.rs
@@ -622,6 +622,10 @@ impl<'a> GrantKernelData<'a> {
     /// Returns a lifetime limited reference to the requested
     /// `ReadOnlyProcessBuffer`.
     ///
+    /// The len of the returned `ReadOnlyProcessBuffer` must be checked by the caller
+    /// to ensure that a buffer has in fact been allocated. An unallocated buffer will
+    /// be returned as a `ReadOnlyProcessBuffer` of length 0.
+    ///
     /// The `ReadOnlyProcessBuffer` is only valid for as long as this object is
     /// valid, i.e. the lifetime of the app enter closure.
     ///
@@ -657,6 +661,10 @@ impl<'a> GrantKernelData<'a> {
     /// Returns a lifetime limited reference to the requested
     /// `ReadWriteProcessBuffer`.
     ///
+    /// The len of the returned `ReadWriteProcessBuffer` must be checked by the caller
+    /// to ensure that a buffer has in fact been allocated. An unallocated buffer will
+    /// be returned as a `ReadWriteProcessBuffer` of length 0.
+    ///
     /// The ReadWriteProcessBuffer is only value for as long as this object is
     /// valid, i.e. the lifetime of the app enter closure.
     ///