Skip to content

Commit

Permalink
Add remark about eventual consistency to Status struct
Browse files Browse the repository at this point in the history
  • Loading branch information
bikeshedder committed May 9, 2024
1 parent 401a0ff commit 2a584a9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ pub mod unmanaged;
pub use deadpool_runtime::{Runtime, SpawnBlockingError};

/// The current pool status.
///
/// **The status returned by the pool is not guaranteed to be consistent!**
///
/// While this features provides [eventual consistency][1] the numbers will be
/// off when accessing the status of a pool under heavy load. These numbers
/// are meant for an overall insight.
///
/// [1]: (https://en.wikipedia.org/wiki/Eventual_consistency)
#[derive(Clone, Copy, Debug)]
pub struct Status {
/// The maximum size of the pool.
Expand Down

0 comments on commit 2a584a9

Please sign in to comment.