xmppftw/xmpp-rs
Watch
1
0
Fork
You've already forked xmpp-rs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

parsers: correct cargo doc warnings

Browse source 
Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
Maxime “pep” Buquet 2022-12-27 16:31:58 +01:00
commit afcf9fb2d0
13 changed files with 36 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

16
parsers/src/hashes.rs
View file

@ -17,37 +17,37 @@ use std::str::FromStr;
pub enum Algo {
/// The Secure Hash Algorithm 1, with known vulnerabilities, do not use it.
///
/// See https://tools.ietf.org/html/rfc3174
/// See <https://tools.ietf.org/html/rfc3174>
Sha_1,
/// The Secure Hash Algorithm 2, in its 256-bit version.
///
/// See https://tools.ietf.org/html/rfc6234
/// See <https://tools.ietf.org/html/rfc6234>
Sha_256,
/// The Secure Hash Algorithm 2, in its 512-bit version.
///
/// See https://tools.ietf.org/html/rfc6234
/// See <https://tools.ietf.org/html/rfc6234>
Sha_512,
/// The Secure Hash Algorithm 3, based on Keccak, in its 256-bit version.
///
/// See https://keccak.team/files/Keccak-submission-3.pdf
/// See <https://keccak.team/files/Keccak-submission-3.pdf>
Sha3_256,
/// The Secure Hash Algorithm 3, based on Keccak, in its 512-bit version.
///
/// See https://keccak.team/files/Keccak-submission-3.pdf
/// See <https://keccak.team/files/Keccak-submission-3.pdf>
Sha3_512,
/// The BLAKE2 hash algorithm, for a 256-bit output.
///
/// See https://tools.ietf.org/html/rfc7693
/// See <https://tools.ietf.org/html/rfc7693>
Blake2b_256,
/// The BLAKE2 hash algorithm, for a 512-bit output.
///
/// See https://tools.ietf.org/html/rfc7693
/// See <https://tools.ietf.org/html/rfc7693>
Blake2b_512,
/// An unknown hash not in this list, you can probably reject it.
@ -109,7 +109,7 @@ generate_element!(
);
impl Hash {
/// Creates a [Hash] element with the given algo and data.
/// Creates a [struct@Hash] element with the given algo and data.
pub fn new(algo: Algo, hash: Vec<u8>) -> Hash {
Hash { algo, hash }
}