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.

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

deprecate decode in favour of decode_opt #21

Closed
hannesm opened this issue Nov 29, 2018 · 2 comments
Closed

deprecate decode in favour of decode_opt #21

hannesm opened this issue Nov 29, 2018 · 2 comments

Comments

@hannesm
Copy link
Member

hannesm commented Nov 29, 2018

since decode raises exceptions. curious whether any user relies on decode. I'd suggest to remove decode and rename decode_opt to decode. what do you think?

@dinosaure
Copy link
Member

Ok with that 👍

@dinosaure
Copy link
Member

See #22

dinosaure added a commit to dinosaure/opam-repository that referenced this issue Jan 21, 2019
CHANGES:

* Implemenation of Base64 according to RFC 2045 (available on base64.rfc2045)
* New implementation of Base64 according to RFC 4648 from nocrypto's implementation
* Fix bad access with `String.iter` on the old implementation of Base64 (@dinosaure, mirage/ocaml-base64#23)
* Check isomorphism between `encode` & `decode` function (@hannesm, @dinosaure, mirage/ocaml-base64#20)
* Add tests from RFC 3548 and from PHP impl. (@hannesm, @dinosaure, mirage/ocaml-base64#24)
* Add fuzzer on both implementations
 - check isomorphism
 - check bijection
 - check if `decode` does not raise any exception
* __break-api__, `B64` was renamed to `Base64` (@copy, @avsm, @dinosaure, mirage/ocaml-base64#17)
* __break-api__, `Base64.decode` and `Base64.encode` returns a result type instead to raise an exception (@hannesm, @dinosaure, mirage/ocaml-base64#21)
* __break-api__, Add `sub` type to avoid allocation to the end-user (@avsm, @dinosaure, mirage/ocaml-base64#24)
* __break-api__, Add `pad` argument on `decode` function to check if input is well-padded or not (@hannesm, @dinosaure, mirage/ocaml-base64#24)
* __break-api__, Add `off` and `len` optional arguments on `encode` & `decode` functions to compute a part of input (@cfcs, @dinosaure, mirage/ocaml-base64#24)
* Better performance (see mirage/ocaml-base64#24) (@dinosaure)
* Review of code by @cfcs (see mirage/ocaml-base64#24)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants