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

Follow Rust API Guidelines #2

Closed
5 tasks done
kodemartin opened this issue Nov 26, 2020 · 0 comments · Fixed by #3
Closed
5 tasks done

Follow Rust API Guidelines #2

kodemartin opened this issue Nov 26, 2020 · 0 comments · Fixed by #3
Assignees
@kodemartin

Comments

@kodemartin
Copy link
Owner

kodemartin commented Nov 26, 2020 •
edited
Loading

Description

Following #1 we want to converge to the Rust API guidelines.

In this context, an indicative list of issues to be revisited are the following:

  • Naming
  • Interoperability
  • Documentation
  • Type safety (especially using bitflags)
  • Debuggability
@kodemartin kodemartin self-assigned this Nov 26, 2020
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Use bitflags for expand::AddressComponents
99e268b 
* Add dependency to Cargo.toml
* Refactor expand module and tests
* Implement Default trait for expand::AddressComponents
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Update use statements
d215934
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Refactor languages field of NormalizeOptions
459641f 
* Add doc test
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Make NormalizeOptions fields private
b1b2e5c 
* Add descriptor methods
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Handle NulError in NormalizeOptions.expand
b7f9a7f
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Add doc for NormalizeOptions.expand
3332d6e
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Refactor expand::expand_address
ee445db
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Minor updates in expand docs
b3f36fc
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Set Iterator::Item to &&str in NormalizeOptions::new
0333694
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Create error module
06ef51e
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Delegate setup/teardown to LibModules
c6078b6
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Refactor tests in expand to setup/teardown through LibModules
9913654
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Fix doc links
70c5dcd
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Refactor address module
e0570ef
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Fix memory management bug in expand module
385e81c
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Remove unnecessary trait derivations
8d0c742
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Update tests
9380bc7
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Revise markdown in doc tests
bdd1967
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Cleanup doc tests
12f98eb
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Add crate-level example
8438c33
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Eagerly derive traits in all public structures
c4717aa
kodemartin added a commit that referenced this issue Jul 19, 2021
@kodemartin
[#2] Fix typo in deprecation note
40346c4
@kodemartin kodemartin mentioned this issue Jul 19, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kodemartin kodemartin

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Refactor API following guidelines kodemartin/rustpostal
1 participant
@kodemartin