Skip to content
This repository was archived by the owner on Dec 12, 2024. It is now read-only.

[SoM] API review #78

Open
rolfbjarne opened this issue Feb 11, 2019 · 0 comments
Open

[SoM] API review #78

rolfbjarne opened this issue Feb 11, 2019 · 0 comments
Milestone

Comments

@rolfbjarne
Copy link
Member

The public SwiftRuntimeLibrary API needs a review.

Things to review:

  • Every API needs a test.
  • Check if classes should be sealed.
  • Improve parameter names (#1346).
  • Try to reduce code duplication as much as possible.
  • Simplify unsafe code as much as possible; complete removal being the best outcome.
  • Simplify P/Invokes by using Unsafe[Mutable]Pointers, which do not need retains/releases.
  • Check API if there's something obvious (from a .NET perspective) missing. Example: I added a Capacity getter to SwiftArray.
  • Throw ObjectDisposedException when needed.
  • Add parameter validation.

Example review for SwiftArray: bf54aaa528c64be5b1d1e6eb97e1e59f493c8002

@stephen-hawley stephen-hawley transferred this issue from another repository Oct 29, 2019
@chamons chamons added this to the Future milestone Nov 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants