Skip to content

Commit b7b95e3

Browse files
committed
stream: Fix FailoverPool doc
1 parent eb8608b commit b7b95e3

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

stream/src/client/failover.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ use std::sync::{
2323
/// Only retry RpcIntErr that less than RpcIntErr::Method,
2424
/// currently ignore custom error due to complexity of generic.
2525
///
26-
/// NOTE: there's cycle reference inside FailoverPoolInner and it's ClientPool,
27-
/// don't clone FailoverPool as it has custom drop. FailoverPool should be put in Arc for usage.
26+
/// NOTE: there's cycle reference inside FailoverPoolInner and its ClientPool,
27+
/// FailoverPool::drop will break the cycle reference. This means we cannot impl Clone for FailoverPool,
28+
/// but you can put FailoverPool within Arc if you need to clone.
2829
pub struct FailoverPool<F, P>(Arc<FailoverPoolInner<F, P>>)
2930
where
3031
F: ClientFacts,

0 commit comments

Comments
 (0)