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 the cloning behavior for Batch #643

Merged
merged 2 commits into from
Jun 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/transports/batch.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ type Pending = oneshot::Sender<error::Result<rpc::Value>>;
type PendingRequests = Arc<Mutex<BTreeMap<RequestId, Pending>>>;

/// Transport allowing to batch queries together.
///
/// Note: cloned instances of [Batch] share the queues of pending and unsent requests.
/// If you want to avoid it, use [Batch::new] repeatedly instead.
#[derive(Debug, Clone)]
pub struct Batch<T> {
transport: T,
Expand Down