fix comemnts in client/creation.rs
This commit is contained in:
parent
d63f711a33
commit
8e1dd7c9ca
|
@ -23,15 +23,16 @@ use tokio_rustls::client::TlsStream;
|
||||||
/// Gets three server salts, generates three new salts, cancatenates both salts, and use the
|
/// Gets three server salts, generates three new salts, cancatenates both salts, and use the
|
||||||
/// concatenated salt to hash the username, email, and password. Generates a message containing the
|
/// concatenated salt to hash the username, email, and password. Generates a message containing the
|
||||||
/// hashes and sends it to the server. Waits for a response and returns.
|
/// hashes and sends it to the server. Waits for a response and returns.
|
||||||
|
/// Should be used in contexts that return ```io:;Result```.
|
||||||
|
/// Should be used in Async contexts.
|
||||||
///
|
///
|
||||||
/// Arguments:
|
/// Arguments:
|
||||||
/// tls_client - The TLS client to use.
|
/// socket - The TLS socket to use.
|
||||||
/// poll - The mio::Poll to get the events from.
|
|
||||||
/// username - The username to send to the server.
|
/// username - The username to send to the server.
|
||||||
/// email - The email to send to the server.
|
/// email - The email to send to the server.
|
||||||
/// password - The password to send to the server.
|
/// password - The password to send to the server.
|
||||||
///
|
///
|
||||||
/// Returns: nothing on success, ReturnFlag on error containing the reason of failure.
|
/// Returns: ```io::Result``` indicating success or failure.
|
||||||
///
|
///
|
||||||
/// Example:
|
/// Example:
|
||||||
/// ```rust
|
/// ```rust
|
||||||
|
|
Loading…
Reference in New Issue