feat!: add length_width to schema::Definition::Sequence
#229
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add Definition::Sequence::length_width field which allows specifying the width of the length tag for dynamically-sized arrays. This allows defining custom schema where length is, say, one-byte. Furthermore, support length_width being zero which indicates untagged sequences. Use that as a new way to describe a fixed-length arrays thus making Definition::Array no longer necessary. Lastly, zero length_width with length range which is more than just one value allows to document a custom encoding which cannot be fully specified with the schema.
dj8yfo
pushed a commit
that referenced
this pull request
Sep 22, 2023
dj8yfo
pushed a commit
that referenced
this pull request
Sep 22, 2023
dj8yfo
pushed a commit
that referenced
this pull request
Sep 22, 2023
|
Duplicate of #228 |
dj8yfo
reviewed
Sep 22, 2023
dj8yfo
reviewed
Sep 23, 2023
| @@ -53,14 +66,15 @@ fn validate_impl<'a>( | |||
| stack.push(declaration); | |||
| match definition { | |||
| Definition::Primitive(_size) => {} | |||
| Definition::Array { elements, .. } => validate_impl(elements, schema, stack)?, | |||
There was a problem hiding this comment.
thread 'validate_for_derived_types' panicked at 'assertion failed: `(left == right)`
left: `Ok(())`,
right: `Err(ZSTSequence("Array<nil, 300>"))`'
dj8yfo
changed the title
length_width to schema::Definition::Sequence
dj8yfo
approved these changes
Sep 23, 2023
Merged
mina86
commented
Sep 23, 2023
Comment on lines
+35
to
+36
| /// only 0, 1, 2, 4 and 8 bytes long enum tags and sequences' `length_width` are alowed | ||
| TagNotPowerOfTwo(Declaration), |
Comment on lines
95
to
112
| // TODO(#230): variants.len() is actually incorrect here. Since | ||
| // arbitrary discriminant can be used for variants, an actual | ||
| // largest discriminant may be larger than the number of variants. | ||
| // For the time being we’re using variants.len() as a proxy but | ||
| // eventually variant discriminants should be added to the schema. | ||
| let max_discriminant = variants.len().saturating_sub(1) as u64; | ||
| check_tag_width(declaration, *tag_width, max_discriminant)?; | ||
| if *tag_width > U64_LEN { | ||
| return Err(Error::TagTooWide(declaration.to_string())); | ||
| } |
There was a problem hiding this comment.
So length_width: 3 is invalid (for whatever reason), but tag_width: 3 is valid?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Definition::Sequence::length_width field which allows specifying
the width of the length tag for dynamically-sized arrays. This allows
defining custom schema where length is, say, one-byte.
Furthermore, support length_width being zero which indicates untagged
sequences. Use that as a new way to describe a fixed-length arrays
thus making Definition::Array no longer necessary.
Lastly, zero length_width with length range which is more than just
one value allows to document a custom encoding which cannot be fully
specified with the schema.
resolves #211 (
VarIntandSmallVec<T>)