Skip to content

fix #1180: Add missing docs for ConnectOptions #1181

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

Merged
merged 2 commits into from
Jan 2, 2024
Merged

fix #1180: Add missing docs for ConnectOptions #1181

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3af187
Add missing docs for ConnectOptions
barafael Dec 26, 2023
fb9ee32
Merge branch 'main' into retry-on-initial-connect-docs
barafael Dec 30, 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
8 changes: 8 additions & 0 deletions async-nats/src/options.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -819,11 +819,19 @@ impl ConnectOptions {
self
}

/// By default, [`ConnectOptions::connect`] will return an error if
/// the connection to the server cannot be established.
///
/// Setting `retry_on_initial_connect` makes the client
/// establish the connection in the background.
pub fn retry_on_initial_connect(mut self) -> ConnectOptions {
self.retry_on_initial_connect = true;
self
}

/// By default, a server may advertise other servers in the cluster known to it.
/// By setting this option, the client will ignore the advertised servers.
/// This may be useful if the client may not be able to reach them.
pub fn ignore_discovered_servers(mut self) -> ConnectOptions {
self.ignore_discovered_servers = true;
self
Expand Down