Fix doc for OptsBuilder #247
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yerke
commented
Aug 25, 2020
| @@ -424,19 +424,19 @@ impl Opts { | |||
| /// Provides a way to build [`Opts`](struct.Opts.html). | |||
| /// | |||
| /// ```ignore | |||
| /// let mut ssl_opts = SslOpts::new(); | |||
There was a problem hiding this comment.
SslOpts::new() doesn't exist, so we need to SslOpts::default().
| @@ -424,19 +424,19 @@ impl Opts { | |||
| /// Provides a way to build [`Opts`](struct.Opts.html). | |||
| /// | |||
| /// ```ignore | |||
| /// let mut ssl_opts = SslOpts::new(); | |||
| /// ssl_opts.set_pkcs12_path("/foo/cert.p12") | |||
There was a problem hiding this comment.
.set_pkcs12_path() doesn't exist, so we need to use .with_pkcs12_path().
| @@ -424,19 +424,19 @@ impl Opts { | |||
| /// Provides a way to build [`Opts`](struct.Opts.html). | |||
| /// | |||
| /// ```ignore | |||
| /// let mut ssl_opts = SslOpts::new(); | |||
| /// ssl_opts.set_pkcs12_path("/foo/cert.p12") | |||
| /// .set_root_ca_path("/foo/root_ca.der"); | |||
There was a problem hiding this comment.
Same here. .set_root_ca_path() doesn't exist, so we need to use .with_root_ca_path().
| /// .db_name(Some("bar")) | ||
| /// .ssl_opts(Some(ssl_opts)); | ||
| /// | ||
| /// // Or use existing T: Into<Opts> | ||
| /// let mut builder = OptsBuilder::from_opts(existing_opts); | ||
| /// builder.ip_or_hostname(Some("foo")) |
There was a problem hiding this comment.
This will not work, since builder will be moved here. So we can either use a mutable variable and assign to it after modifications (like in example above), or we can go Builder pattern all the way.
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix doc for OptsBuilder