dnim/rust-postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc cleanup

Browse Source
This commit is contained in:
Steven Fackler 2016-02-10 22:57:41 -08:00
parent 32efe3080c
commit dcd621b48a
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/lib.rs
View File

@ -117,16 +117,16 @@ pub enum ConnectTarget {
/// Authentication information. /// Authentication information.
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct UserInfo { pub struct UserInfo {
/// The username /// The username.
pub user: String, pub user: String,
/// An optional password /// An optional password.
pub password: Option<String>, pub password: Option<String>,
} }
/// Information necessary to open a new connection to a Postgres server. /// Information necessary to open a new connection to a Postgres server.
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct ConnectParams { pub struct ConnectParams {
/// The target server /// The target server.
pub target: ConnectTarget, pub target: ConnectTarget,
/// The target port. /// The target port.
/// ///
@ -136,7 +136,9 @@ pub struct ConnectParams {
/// ///
/// `Connection::connect` requires a user but `cancel_query` does not. /// `Connection::connect` requires a user but `cancel_query` does not.
pub user: Option<UserInfo>, pub user: Option<UserInfo>,
/// The database to connect to. Defaults the value of `user`. /// The database to connect to.
///
/// Defaults the value of `user`.
pub database: Option<String>, pub database: Option<String>,
/// Runtime parameters to be passed to the Postgres backend. /// Runtime parameters to be passed to the Postgres backend.
pub options: Vec<(String, String)>, pub options: Vec<(String, String)>,