Skip to content

Commit

Permalink
Fix docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
blackbeam committed Nov 8, 2023
1 parent 5e94f56 commit 9d08837
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/local_infile_handler/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pub type InfileData = BoxStream<'static, std::io::Result<Bytes>>;
/// **Warning:** You should be aware of [Security Considerations for LOAD DATA LOCAL][1].
///
/// The purpose of the handler is to emit infile data in response to a file name.
/// This handler will be called if there is no [`LocalHandler`] installed for the connection.
/// This handler will be called if there is no local handler installed for the connection.
///
/// The library will call this handler in response to a LOCAL INFILE request from the server.
/// The server, in its turn, will emit LOCAL INFILE requests in response to a `LOAD DATA LOCAL`
Expand Down
9 changes: 7 additions & 2 deletions src/opts/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ impl PoolOpts {
/// So to encrease overall performance you can safely opt-out of the default behavior
/// if you are not willing to change the session state in an unpleasant way.
///
/// It is also possible to selectively opt-in/out using [`Conn::reset_connection`].
/// It is also possible to selectively opt-in/out using [`Conn::reset_connection`][1].
///
/// # Connection URL
///
Expand All @@ -266,6 +266,8 @@ impl PoolOpts {
/// assert_eq!(opts.pool_opts().reset_connection(), false);
/// # Ok(()) }
/// ```
///
/// [1]: crate::Conn::reset_connection
pub fn with_reset_connection(mut self, reset_connection: bool) -> Self {
self.reset_connection = reset_connection;
self
Expand Down Expand Up @@ -635,7 +637,10 @@ impl Opts {
}

/// Commands to execute on new connection and every time
/// [`Conn::reset`] or [`Conn::change_user`] is invoked.
/// [`Conn::reset`][1] or [`Conn::change_user`][2] is invoked.
///
/// [1]: crate::Conn::reset
/// [2]: crate::Conn::change_user
pub fn setup(&self) -> &[String] {
self.inner.mysql_opts.setup.as_ref()
}
Expand Down

0 comments on commit 9d08837

Please sign in to comment.