Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(binary): Clarify TLV parser names #396

Merged
merged 4 commits into from
Dec 11, 2023
Merged

fix(binary): Clarify TLV parser names #396

merged 4 commits into from
Dec 11, 2023

Conversation

epage
Copy link
Collaborator

@epage epage commented Dec 11, 2023

Fixes #394

@epage
fix(binary): Clarify length_data as length_take
c174d4a 
`take` is generally the verb we use for creating slices, maing the
intent more obvious.
@epage
fix(binary): Clarify length_value as length_and_then
2538d04 
Since this is like `Parser::and_then`, I went with that name, even if I
don't like it.
@epage
fix(binary): Clarify length_count as length_repeat
aa95f42 
`count` was renamed to `repeat`.  Being consistent will make it easier
to recognize.
@epage
docs(binary): Try to make TLV parsers more obvious
bc6fefd 
- Briefer first-line
- Consistent style for first-line
- highlight TLV in first line
- Cross-link with eachother
- Have "Why?" cross-link to them

Inspired by winnow-rs#393
@coveralls
Copy link

Pull Request Test Coverage Report for Build 7173252910

  • 7 of 10 (70.0%) changed or added relevant lines in 1 file are covered.
  • 4 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.2%) to 43.016%
Changes Missing Coverage Covered Lines Changed/Added Lines %
src/binary/mod.rs 7 10 70.0%
Files with Coverage Reduction New Missed Lines %
src/ascii/mod.rs 4 52.17%
Totals Coverage Status
Change from base Build 7171329429: -0.2%
Covered Lines: 1235
Relevant Lines: 2871
💛 - Coveralls

@epage epage merged commit 0108618 into winnow-rs:main Dec 11, 2023
15 checks passed
@epage epage deleted the tlv branch December 11, 2023 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

length_* parser names are unclear
2 participants
@epage @coveralls