From 5cc7171b5f34a8aa0d20a042243c1deea700657d Mon Sep 17 00:00:00 2001 From: edef Date: Mon, 9 Oct 2023 17:56:11 +0000 Subject: docs(tvix/nix-compat): mention Directory::close on Node::directory Change-Id: I19e6a3b63eb1b1609b96544b2529d71234bcb13b Reviewed-on: https://cl.tvl.fyi/c/depot/+/9613 Reviewed-by: flokli Autosubmit: edef Tested-by: BuildkiteCI --- tvix/nix-compat/src/nar/writer/mod.rs | 3 +++ 1 file changed, 3 insertions(+) (limited to 'tvix/nix-compat/src/nar/writer/mod.rs') diff --git a/tvix/nix-compat/src/nar/writer/mod.rs b/tvix/nix-compat/src/nar/writer/mod.rs index ffc1a9f30e..f73d323e38 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> { self.write(&wire::TOK_DIR)?; Ok(Directory::new(self)) -- cgit 1.4.1