Skip to content

Commit 7f0e575

Browse files
committed
Rust wrapper: fix ed448 documentation issues from code review
1 parent b82cccc commit 7f0e575

File tree

1 file changed

+10
-13
lines changed
  • wrapper/rust/wolfssl/src/wolfcrypt

1 file changed

+10
-13
lines changed

wrapper/rust/wolfssl/src/wolfcrypt/ed448.rs

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,8 @@ impl Ed448 {
193193
///
194194
/// # Returns
195195
///
196-
/// Returns either Ok(size) containing the number of bytes written to
197-
/// `public` on success or Err(e) containing the wolfSSL library error
198-
/// code value.
196+
/// Returns either Ok(()) on success or Err(e) containing the wolfSSL
197+
/// library error code value.
199198
///
200199
/// # Example
201200
///
@@ -228,9 +227,8 @@ impl Ed448 {
228227
///
229228
/// # Returns
230229
///
231-
/// Returns either Ok(size) containing the number of bytes written to
232-
/// `keyout` on success or Err(e) containing the wolfSSL library error
233-
/// code value.
230+
/// Returns either Ok(()) on success or Err(e) containing the wolfSSL
231+
/// library error code value.
234232
///
235233
/// # Example
236234
///
@@ -263,9 +261,8 @@ impl Ed448 {
263261
///
264262
/// # Returns
265263
///
266-
/// Returns either Ok(size) containing the number of bytes written to
267-
/// `private` on success or Err(e) containing the wolfSSL library error
268-
/// code value.
264+
/// Returns either Ok(()) on success or Err(e) containing the wolfSSL
265+
/// library error code value.
269266
///
270267
/// # Example
271268
///
@@ -1084,7 +1081,7 @@ impl Ed448 {
10841081
Ok(res == 1)
10851082
}
10861083

1087-
/// Get the size of an Ed448 key (32 bytes).
1084+
/// Get the size of an Ed448 key (57 bytes).
10881085
///
10891086
/// # Returns
10901087
///
@@ -1109,7 +1106,7 @@ impl Ed448 {
11091106
Ok(rc as usize)
11101107
}
11111108

1112-
/// Get the size of a private (including public) Ed448 key (64 bytes).
1109+
/// Get the size of a private (including public) Ed448 key (114 bytes).
11131110
///
11141111
/// # Returns
11151112
///
@@ -1134,7 +1131,7 @@ impl Ed448 {
11341131
Ok(rc as usize)
11351132
}
11361133

1137-
/// Get the size of a public Ed448 key (32 bytes).
1134+
/// Get the size of a public Ed448 key (57 bytes).
11381135
///
11391136
/// # Returns
11401137
///
@@ -1159,7 +1156,7 @@ impl Ed448 {
11591156
Ok(rc as usize)
11601157
}
11611158

1162-
/// Get the size of a Ed448 signature (64 bytes).
1159+
/// Get the size of a Ed448 signature (114 bytes).
11631160
///
11641161
/// # Returns
11651162
///

0 commit comments

Comments
 (0)