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.

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

docs(swarm): fix stale docs around confirmed addresses #4135

Merged
merged 2 commits into from
Jul 1, 2023
Merged

docs(swarm): fix stale docs around confirmed addresses #4135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b77f480
Fix docs around confirmed addresses
thomaseizinger Jun 30, 2023
26f6884
Merge branch 'master' into docs/external-address
mergify[bot] Jul 1, 2023
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
7 changes: 3 additions & 4 deletions swarm/src/behaviour.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ pub enum FromSwarm<'a, Handler> {
ListenerClosed(ListenerClosed<'a>),
/// Informs the behaviour that we have discovered a new candidate for an external address for us.
NewExternalAddrCandidate(NewExternalAddrCandidate<'a>),
/// Informs the behaviour that an external address of the local node was removed.
/// Informs the behaviour that an external address of the local node was confirmed.
ExternalAddrConfirmed(ExternalAddrConfirmed<'a>),
/// Informs the behaviour that an external address of the local node expired, i.e. is no-longer confirmed.
ExternalAddrExpired(ExternalAddrExpired<'a>),
Expand Down Expand Up @@ -541,14 +541,13 @@ pub struct ListenerClosed<'a> {
pub reason: Result<(), &'a std::io::Error>,
}

/// [`FromSwarm`] variant that informs the behaviour
/// that we have discovered a new candidate for an external address for us.
/// [`FromSwarm`] variant that informs the behaviour about a new candidate for an external address for us.
#[derive(Clone, Copy)]
pub struct NewExternalAddrCandidate<'a> {
pub addr: &'a Multiaddr,
}

/// [`FromSwarm`] variant that informs the behaviour that an external address was removed.
/// [`FromSwarm`] variant that informs the behaviour that an external address was confirmed.
#[derive(Clone, Copy)]
pub struct ExternalAddrConfirmed<'a> {
pub addr: &'a Multiaddr,
Expand Down