Skip to content

docs(core): add example to TransportTimeout #6152

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(core): add example to TransportTimeout #6152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 17 additions & 1 deletion core/src/transport/timeout.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,23 @@
//!
//! The connection setup includes all protocol upgrades applied on the
//! underlying `Transport`.
// TODO: add example
//!
//! # Example
//!
//! ```no_run
//! use std::time::Duration;
//!
//! use libp2p_core::{
//! transport::{timeout::TransportTimeout, ListenerId, MemoryTransport},
//! Transport as _,
//! };
//!
//! let base = MemoryTransport::default();
//! let mut timeout = TransportTimeout::new(base, Duration::from_secs(1));
//!
//! // Listen and dial as usual; the setup will be subject to timeouts.
//! let _ = timeout.listen_on(ListenerId::next(), "/memory/0".parse().unwrap());
//! ```

use std::{
error, fmt, io,
Expand Down