docs: provide an example to explain the cloning inner services #762
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
david-perez
reviewed
Jun 10, 2024
| @@ -236,7 +236,10 @@ use std::task::{Context, Poll}; | |||
| /// | |||
| /// Services are permitted to panic if `call` is invoked without obtaining `Poll::Ready(Ok(()))` | |||
| /// from `poll_ready`. You should therefore be careful when cloning services for example to move | |||
| /// them into boxed futures. Even though the original service is ready, the clone might not be. | |||
| /// them into boxed futures. Even though the original service is ready, the clone might not be, | |||
There was a problem hiding this comment.
I don't understand how ConcurrencyLimit exemplifies what this docs section is trying to convey. If you're referring to the fact that cloning an inner ConcurrencyLimit service resets the permit to unacquired and that poll_ready acquires it, that will only be understood by readers who have read ConcurrencyLimit's source code.
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.
Provide the example "ConcurrencyLimit" to explain why "Even though the original service is ready, the clone might not be".
https://docs.rs/tower/latest/tower/limit/struct.ConcurrencyLimit.html#impl-Clone