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

Document usage of tower middleware like retry #140

Closed
onbjerg opened this issue Jan 22, 2024 · 3 comments · Fixed by #849
Closed

Document usage of tower middleware like retry #140

onbjerg opened this issue Jan 22, 2024 · 3 comments · Fixed by #849
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@onbjerg
Copy link
Member

onbjerg commented Jan 22, 2024

Component

providers, pubsub, transports

Describe the feature you would like

We should explain that the transports are tower services and how to layer things like retries/backoff (with a simple example) in either the provider or transport docs (or both).

Additional context

No response

@onbjerg onbjerg added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 22, 2024
@DaniPopes DaniPopes added this to the 0.1-rc.0 milestone Jun 5, 2024
@DaniPopes DaniPopes removed the 0.1-rc.0 label Jun 5, 2024
@zerosnacks
Copy link
Member

I think because there are already quite a few references

/// A layering abstraction in the vein of [`tower::Layer`]
///
/// [`tower::Layer`]: https://docs.rs/tower/latest/tower/trait.Layer.html
to Tower layers and
/// This trait is blanket implemented for all appropriate types. To implement
/// this trait, you must implement the [`tower::Service`] trait with the
/// appropriate associated types. It cannot be implemented directly.
and Tower services it will be sufficiently covered once the retry-layer example is merged and available as a practical example alloy-rs/examples#95 cc @yash-atreya

@zerosnacks zerosnacks added wontfix This will not be worked on and removed wontfix This will not be worked on labels Jun 7, 2024
@zerosnacks zerosnacks removed their assignment Jun 7, 2024
@onbjerg
Copy link
Member Author

onbjerg commented Jun 10, 2024

i was more thinking around using built-in tower layers, or an example showing how to build and use a tower layer. but ultimately defer to you guys if you think #849 is sufficient:)

@gakonst
Copy link
Member

gakonst commented Jun 11, 2024

i agree i'd like to have a "real" tower layer used here too

@DaniPopes DaniPopes removed this from the 0.1 milestone Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants