From 4e8fd53e7038c816237da67ec28342897d3e0286 Mon Sep 17 00:00:00 2001 From: alessandrokonrad Date: Sun, 16 Oct 2022 20:51:14 -0400 Subject: [PATCH] fixed comments --- crates/flat/src/decode/decoder.rs | 4 ++-- crates/flat/src/encode/encoder.rs | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/flat/src/decode/decoder.rs b/crates/flat/src/decode/decoder.rs index 51be5905..7b2a966b 100644 --- a/crates/flat/src/decode/decoder.rs +++ b/crates/flat/src/decode/decoder.rs @@ -35,7 +35,7 @@ impl<'b> Decoder<'b> { Ok(zigzag::to_isize(self.word()?)) } - /// Decode an integer of any size. + /// Decode an integer of 128 bits size. /// This is byte alignment agnostic. /// First we decode the next 8 bits of the buffer. /// We take the 7 least significant bits as the 7 least significant bits of the current unsigned integer. @@ -142,7 +142,7 @@ impl<'b> Decoder<'b> { Ok(final_word) } - /// Decode a word of any size. + /// Decode a word of 128 bits size. /// This is byte alignment agnostic. /// First we decode the next 8 bits of the buffer. /// We take the 7 least significant bits as the 7 least significant bits of the current unsigned integer. diff --git a/crates/flat/src/encode/encoder.rs b/crates/flat/src/encode/encoder.rs index 1b5f7cde..ea6eb0de 100644 --- a/crates/flat/src/encode/encoder.rs +++ b/crates/flat/src/encode/encoder.rs @@ -98,7 +98,7 @@ impl Encoder { self } - /// Encode an integer of any size. + /// Encode an integer of 128 bits size. /// This is byte alignment agnostic. /// First we use zigzag once to double the number and encode the negative sign as the least significant bit. /// Next we encode the 7 least significant bits of the unsigned integer. If the number is greater than @@ -165,7 +165,7 @@ impl Encoder { self } - /// Encode a unsigned integer of any size. + /// Encode a unsigned integer of 128 bits size. /// This is byte alignment agnostic. /// We encode the 7 least significant bits of the unsigned byte. If the char value is greater than /// 127 we encode a leading 1 followed by repeating the above for the next 7 bits and so on.