Skip to content

Commit

Permalink
Expands doc comment on BinaryValueEncoding
Browse files Browse the repository at this point in the history
  • Loading branch information
zslayton committed Sep 7, 2024
1 parent 626cbfa commit 8ecd1c4
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/lazy/binary/raw/v1_1/value.rs
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ impl<'top> RawVersionMarker<'top> for LazyRawBinaryVersionMarker_1_1<'top> {
///
/// This is a subset of the encodings in the
/// [`ParameterEncoding`](crate::lazy::expanded::template::ParameterEncoding) enum.
/// `BinaryValueEncoding` contains only those variants that can back a binary value literal--
/// encodings that are not macro-shaped.
///
/// When `LazyRawBinaryValue::read()` is called, this enum is inspected to determine how the
/// bytes in the `BinaryBuffer` should be parsed to yield the value it represents.
#[derive(Debug, Copy, Clone, PartialEq)]
pub enum BinaryValueEncoding {
Tagged,
Expand Down

0 comments on commit 8ecd1c4

Please sign in to comment.