Skip to content

Commit 79fc6f1

Browse files
fix(gossipsub): fixed incorrect default values in ConfigBuilder
Fixed minor doc issue in ConfigBuilder Fixes #6111 Pull-Request: #6113.
1 parent 1bf4f73 commit 79fc6f1

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

protocols/gossipsub/CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
- Fix `unsubscribe_backoff` expecting number of seconds instead of `Duration`
99
See [PR 6124](https://github.com/libp2p/rust-libp2p/pull/6124)
1010

11+
- Fix incorrect default values in ConfigBuilder
12+
See [PR 6113](https://github.com/libp2p/rust-libp2p/pull/6113)
13+
1114
## 0.49.2
1215

1316
- Relax `Behaviour::with_metrics` requirements, do not require DataTransform and TopicSubscriptionFilter to also impl Default

protocols/gossipsub/src/config.rs

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -761,13 +761,22 @@ impl ConfigBuilder {
761761
self
762762
}
763763

764-
/// The maximum byte size for each gossip (default is 2048 bytes).
764+
/// The maximum byte size for each gossip (default is 65536 bytes).
765+
///
766+
/// ```rust
767+
/// use libp2p_gossipsub::ConfigBuilder;
768+
/// let mut config = ConfigBuilder::default();
769+
/// assert_eq!(config.build().unwrap().max_transmit_size(), 65536);
770+
/// config.max_transmit_size(1 << 20);
771+
/// assert_eq!(config.build().unwrap().max_transmit_size(), 1 << 20);
772+
/// ```
765773
pub fn max_transmit_size(&mut self, max_transmit_size: usize) -> &mut Self {
766774
self.config.protocol.default_max_transmit_size = max_transmit_size;
767775
self
768776
}
769777

770-
/// The maximum byte size for each gossip for a given topic. (default is 2048 bytes).
778+
/// The maximum byte size for each gossip for a given topic. (default is
779+
/// [`Self::max_transmit_size`]).
771780
pub fn max_transmit_size_for_topic(
772781
&mut self,
773782
max_transmit_size: usize,

0 commit comments

Comments
 (0)