diff --git a/examples/async.rs b/examples/async.rs index 95e9fa0..3690c04 100644 --- a/examples/async.rs +++ b/examples/async.rs @@ -2,6 +2,8 @@ use anyhow::Result; use backon::ExponentialBuilder; use backon::Retryable; +// For more examples, please see: https://docs.rs/backon/#examples + async fn fetch() -> Result { let response = reqwest::get("https://httpbingo.org/unstable?failure_rate=0.7").await?; if !response.status().is_success() { diff --git a/examples/blocking.rs b/examples/blocking.rs index d8b37d5..4d2f5c9 100644 --- a/examples/blocking.rs +++ b/examples/blocking.rs @@ -2,6 +2,8 @@ use anyhow::Result; use backon::BlockingRetryable; use backon::ExponentialBuilder; +// For more examples, please see: https://docs.rs/backon/#examples + fn fetch() -> Result { Ok("hello, world!".to_string()) } diff --git a/examples/closure.rs b/examples/closure.rs index fbfcd3a..e14b227 100644 --- a/examples/closure.rs +++ b/examples/closure.rs @@ -2,6 +2,8 @@ use anyhow::Result; use backon::BlockingRetryable; use backon::ExponentialBuilder; +// For more examples, please see: https://docs.rs/backon/#examples + fn main() -> Result<()> { let var = 42; // `f` can use input variables diff --git a/src/retry.rs b/src/retry.rs index e8b9bb5..83f20d6 100644 --- a/src/retry.rs +++ b/src/retry.rs @@ -38,28 +38,10 @@ use crate::Backoff; /// } /// ``` /// -/// # Example +/// # Examples /// -/// ```no_run -/// use anyhow::Result; -/// use backon::ExponentialBuilder; -/// use backon::Retryable; +/// For more examples, please see: [https://docs.rs/backon/#examples](https://docs.rs/backon/#examples) /// -/// async fn fetch() -> Result { -/// Ok(reqwest::get("https://www.rust-lang.org") -/// .await? -/// .text() -/// .await?) -/// } -/// -/// #[tokio::main(flavor = "current_thread")] -/// async fn main() -> Result<()> { -/// let content = fetch.retry(&ExponentialBuilder::default()).await?; -/// println!("fetch succeeded: {}", content); -/// -/// Ok(()) -/// } -/// ``` pub trait Retryable< B: BackoffBuilder, T,