Debug and doc fixes #451
Debug and doc fixes #451
Conversation
crates/deadpool/src/managed/pool.rs
Outdated
| slots: Mutex<Slots<ObjectInner<M>>>, | ||
| /// Number of ['Pool'] users. A user is both a future which is waiting for an ['Object'] or one | ||
| /// with an ['Object'] which hasn't been returned, yet. | ||
| /// Number of [`Pool`] users. A user is any future that has acquired a semaphore permit, |
There was a problem hiding this comment.
A user is both a future that is waiting for a semaphore permit and a future that has acquired a permit. Essentially the semaphore is the first line of defense to borrow an object from the pool. If a future has acquired a permit it is allowed to either reuse an object stored in the slots vector or create a new one. A future that hasn't acquired a future is considered "waiting".
There was a problem hiding this comment.
Ah, yeah, "acquired" is incorrect. Let me think more on this one--I'll reword or drop it shortly.
There was a problem hiding this comment.
Dropping for now--if I come up with anything better I'll submit it.
There was a problem hiding this comment.
What do you think of this instead?
- /// Number of [`Pool`] users. A user is both a future which is waiting for an [`Object`] or one
- /// with an [`Object`] which hasn't been returned, yet.
+ /// Number of [`Pool`] users. A user is a future, including both those waiting for an [`Object`]
+ /// and those currently holding an [`Object`].
If you like it, I'm happy to add it to this PR or submit it as a followup PR.
bikeshedder
added
documentation
Fixes: 9426cce("Fix default pool max size")
|
Thanks a lot! 🥳 |
2 participants
No description provided.