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

v0.2 & v1.0 milestones #2

Open
3 of 14 tasks
the6p4c opened this issue Jun 26, 2020 · 0 comments
Open
3 of 14 tasks

v0.2 & v1.0 milestones #2

the6p4c opened this issue Jun 26, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@the6p4c
Copy link
Owner

the6p4c commented Jun 26, 2020 •
edited
Loading

v0.2 milestones

  • Add aliases:
    • reader::read_records -> crate::read_records
    • reader::Error -> crate::ReaderError
    • writer::generate_srec_file -> crate::generate_srec_file
  • Improve reader example to show matching on records, reading from Data struct
  • Implement Into<u32> for address structs

v1.0 milestones

  • Make aliases in crate root the public API, un-pub modules
  • Store S0 record data as a vector of bytes, not a string (see ehaskins@a0fe1bd)
  • Restrict Address24 and Count24 to 24 bits
  • Improve return type of read_records to be more palatable (e.g. Reader)
  • Improve reader error reporting
    • Include line number in error (enum Error -> struct Error + enum ErrorType)
    • Include character in unexpected character error
    • Store expected and actual checksum in invalid checksum error
  • Consider renaming generate_srec_file
  • Document + expose Record::encode and FromStr for Record
  • Allow customisation of line endings in generate_srec_file
@the6p4c the6p4c added the enhancement New feature or request label Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@the6p4c