[refactor] config: Use dedicated functions to set options #153
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kgraefe
force-pushed
the
refactor-configs
branch
2 times, most recently
from
9b01c64
to
a07fde4
Compare
kgraefe
changed the title
With public members in the config structs the public API breaks each time we're adding new options as the users MUST or MUST NOT add ".. Default::default()" depending on whether they're setting all options or not. So adding new options breaks for those users who use all options. This change hides the members from the users and replaces access by dedicated setter functions for each option so adding new options does not break API in the future. (This change obviously is an API break in itself.) Signed-off-by: Konrad Gräfe <kgraefe@paktolos.net>
kgraefe
force-pushed
the
refactor-configs
branch
from
a07fde4
to
20bb5fa
Compare
lemunozm
requested changes
May 3, 2023
| /// Enables TCP keepalive settings on the socket. | ||
| pub keepalive: Option<TcpKeepalive>, | ||
| pub fn with_keepalive(mut self, keepalive: TcpKeepalive) -> Self { |
There was a problem hiding this comment.
I would reexport TcpKeepalive type to avoid the user creating a dependency of socket2 only for its usage. Something like:
pub use socket2::TcpKeepalive;in the top of the file.
Signed-off-by: Konrad Gräfe <kgraefe@paktolos.net>
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With public members in the config structs the public API breaks each time we're adding new options as the users MUST or MUST NOT add
.. Default::default()depending on whether they're setting all options or not. So adding new options breaks for those users who use all options.This change hides the members from the users and replaces access by dedicated setter functions for each option so adding new options does not break API in the future. (This change obviously is an API break in itself.)