From b66a64fe5851d244ad524d739b5685c42dddbfb3 Mon Sep 17 00:00:00 2001 From: Berkus Decker Date: Wed, 2 Dec 2020 01:08:22 +0200 Subject: [PATCH] [sq] update doc-comments --- nucleus/src/arch/aarch64/caps.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/nucleus/src/arch/aarch64/caps.rs b/nucleus/src/arch/aarch64/caps.rs index d04a36c..4787629 100644 --- a/nucleus/src/arch/aarch64/caps.rs +++ b/nucleus/src/arch/aarch64/caps.rs @@ -503,13 +503,17 @@ impl DerivationTreeNode { Self(LocalRegisterCopy::new(0)) } + /// Get previous link in derivation tree. + /// Previous link exists if this is a derived capability. + /// /// SAFETY: it is UB to get prev reference from a null Prev pointer. pub unsafe fn get_prev(&self) -> CapTableEntry { let ptr = self.0.read(CapDerivationNode::Prev) as *const CapTableEntry; (*ptr).clone() } - /// Get previous link in derivation tree - this is a derived-from capability. + /// Try to get previous link in derivation tree. + /// Previous link exists if this is a derived capability. pub fn try_get_prev(&self) -> Result { if self.0.read(CapDerivationNode::Prev) == 0 { Err(DerivationTreeError::InvalidPrev)