fix comments in assert_msg.rs

This commit is contained in:
ayham 2021-07-17 10:49:52 +03:00
parent d0f39990b2
commit b25b2f6625
Signed by: ayham
GPG Key ID: EAB7F5A9DF503678
2 changed files with 8 additions and 1 deletions

View File

@ -4,13 +4,20 @@ use crate::common::message::message_type::MessageType;
/// Asserts a recieved message meta information.
///
/// Takes in a message and meta information to check the message against.
/// Can be used to check some attributes.
/// For example, you can check for message to have an X amount of arguments, and
/// not check how many arguments are passed.
///
/// Arguments:
/// message - The mesage to assert against.
/// msg_type - MessageType expected.
/// check_arg_cnt - Whether to check for the argument account.
/// arg_cnt - The argument count expected.
/// check_dnum - Whether to check for the number data message.
/// msg_dnum - The number of the data message.
/// check_dmax - Whether to check for the max data message.
/// msg_dmax - The number of the max data message.
/// check_len - Whether to check for the data payload length.
/// data_len - The length of the data payload.
///
/// Returns: a boolean.

View File

@ -7,7 +7,7 @@
/// user - The name of the user to connect to the database with.
/// pass - The password of the user to connect to the database with.
///
/// Returns: ```Result``` wrapping ```tokio_postgres::Client``` on success,
/// Returns: ```Result``` wrapping ```tokio_postgres::Client``` on success,
/// and ```tokio_postgres::Error``` on error.
///
/// Example: