about summary refs log tree commit diff
path: root/tvix/nix-compat/src
diff options
context:
space:
mode:
authoredef <edef@edef.eu>2023-10-09T17·56+0000
committeredef <edef@edef.eu>2023-10-09T18·39+0000
commit5cc7171b5f34a8aa0d20a042243c1deea700657d (patch)
treea3a7f5273cb8129141c731fbfb4e61be7fc8cec7 /tvix/nix-compat/src
parentca1ede17cba6d029a8b60d5328ca51a43098491f (diff)
docs(tvix/nix-compat): mention Directory::close on Node::directory r/6754
Change-Id: I19e6a3b63eb1b1609b96544b2529d71234bcb13b
Reviewed-on: https://cl.tvl.fyi/c/depot/+/9613
Reviewed-by: flokli <flokli@flokli.de>
Autosubmit: edef <edef@edef.eu>
Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/nix-compat/src')
-rw-r--r--tvix/nix-compat/src/nar/writer/mod.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/tvix/nix-compat/src/nar/writer/mod.rs b/tvix/nix-compat/src/nar/writer/mod.rs
index ffc1a9f30e8e..f73d323e3820 100644
--- a/tvix/nix-compat/src/nar/writer/mod.rs
+++ b/tvix/nix-compat/src/nar/writer/mod.rs
@@ -129,6 +129,9 @@ impl<'a, 'w> Node<'a, 'w> {
 
     /// Make this node a directory, the content of which is set using the
     /// resulting [`Directory`] value.
+    ///
+    /// It is the caller's responsibility to invoke [`Directory::close`],
+    /// or invalid archives will be produced silently.
     pub fn directory(mut self) -> io::Result<Directory<'a, 'w>> {
         self.write(&wire::TOK_DIR)?;
         Ok(Directory::new(self))