about summary refs log tree commit diff
path: root/tvix/nix-compat/src/wire/bytes_writer.rs
diff options
context:
space:
mode:
Diffstat (limited to 'tvix/nix-compat/src/wire/bytes_writer.rs')
-rw-r--r--tvix/nix-compat/src/wire/bytes_writer.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/tvix/nix-compat/src/wire/bytes_writer.rs b/tvix/nix-compat/src/wire/bytes_writer.rs
index 933b0e6efa6c..8bd0a2d00ef6 100644
--- a/tvix/nix-compat/src/wire/bytes_writer.rs
+++ b/tvix/nix-compat/src/wire/bytes_writer.rs
@@ -6,7 +6,7 @@ use tokio::io::AsyncWrite;
 use super::bytes::EMPTY_BYTES;
 
 /// The length of the size field, in bytes is always 8.
-const LEN_SIZE: usize = 8;
+pub(crate) const LEN_SIZE: usize = 8;
 
 pin_project! {
     /// Writes a "bytes wire packet" to the underlying writer.
@@ -52,6 +52,8 @@ pin_project! {
 /// move to the beginning of the next one:
 /// - Size(LEN_SIZE) must be expressed as Payload(0)
 /// - Payload(self.payload_len) must be expressed as Padding(0)
+/// There's one exception - Size(LEN_SIZE) in the reader represents a failure
+/// state we enter in case the allowed size doesn't match the allowed range.
 ///
 /// Padding(padding_len) means we're at the end of the bytes wire packet.
 #[derive(Clone, Debug, PartialEq, Eq)]