diff options
| author | Florian Klink <flokli@flokli.de> | 2024-03-19T10·54+0200 |
|---|---|---|
| committer | clbot <clbot@tvl.fyi> | 2024-03-20T12·17+0000 |
| commit | 591edf0d5b5e4910f0a4688028348e423d723253 (patch) | |
| tree | fc9bb5f1fcd94bb59ecf026d0e67c5718873a4e5 | |
| parent | 65b8359ff3ce1bed882f2d773fe137b673531801 (diff) | |
docs(tvix/castore/directory): update docstring for get_recursive r/7748
The rust trait was missing to document the order of the elements in the stream. Document that, and also the reasoning behind this. Change-Id: I27ef0b2020082783fc41c2015233175e2b8e716d Reviewed-on: https://cl.tvl.fyi/c/depot/+/11203 Reviewed-by: raitobezarius <tvl@lahfa.xyz> Autosubmit: flokli <flokli@flokli.de> Tested-by: BuildkiteCI
| -rw-r--r-- | tvix/castore/src/directoryservice/mod.rs | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/tvix/castore/src/directoryservice/mod.rs b/tvix/castore/src/directoryservice/mod.rs index 8a10121d6d..ca8e60e873 100644 --- a/tvix/castore/src/directoryservice/mod.rs +++ b/tvix/castore/src/directoryservice/mod.rs @@ -44,7 +44,10 @@ pub trait DirectoryService: Send + Sync { /// Rust doesn't support this as a generic in traits yet. This is the same thing that /// [async_trait] generates, but for streams instead of futures. /// - /// The individual Directory messages *must* be valid. + /// The individually returned Directory messages *must* be valid. + /// Directories are sent in an order from the root to the leaves, so that + /// the receiving side can validate each message to be a connected to the root + /// that has initially been requested. fn get_recursive( &self, root_directory_digest: &B3Digest, |