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

API improvements #254

Merged
merged 2 commits into from
Dec 1, 2024
Merged

API improvements #254

merged 2 commits into from
Dec 1, 2024

Conversation

divarvel
Copy link
Collaborator

  • top-level exports for Algorithm, *Builder
  • restore KeyPair::new(), introduce KeyPair::new_with_algorithm()

see commit messages for the rationale

- Algorithm is used by KeyPair::new()
- BiscuitBuilder, BlockBuilder, AuthorizerBuilder are used a lot and have `builder` in their names, so a top-level export makes sense
@divarvel divarvel requested a review from Geal November 30, 2024 09:12
@divarvel divarvel changed the base branch from main to v5 November 30, 2024 09:12
Copy link

codspeed-hq bot commented Nov 30, 2024

CodSpeed Performance Report

Merging #254 will not alter performance

Comparing top-level-exports (3624478) with v5 (0dab828)

Summary

✅ 12 untouched benchmarks

This has been the default behaviour since biscuit 2. Taking the algorithm as a parameter is a breaking change which is IMO not necessary. This will make the update a little bit less painful for consumers.

Also, I don’t know the consensus on having `Default::default()` not return the same value every time, but I find it a bit misleading.
@divarvel divarvel merged commit 3bd7a7b into v5 Dec 1, 2024
4 of 5 checks passed
@divarvel divarvel deleted the top-level-exports branch December 1, 2024 16:27
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

Successfully merging this pull request may close these issues.

2 participants