fix warnings in cargo doc

This commit is contained in:
Evan Richter 2021-02-24 16:24:23 -06:00
parent 2eee4065e1
commit 26747226a6
No known key found for this signature in database
GPG Key ID: CCB6AE3EF39EB1AC
2 changed files with 6 additions and 2 deletions

View File

@ -6,6 +6,7 @@ client_out_map. If the ringbuf is filled up, they start place a
LLMP_AGE_END_OF_PAGE_V1 msg and alloc a new shmap.
Once the broker mapped a page, it flags it save for unmapping.
```text
[client0] [client1] ... [clientN]
| | /
[client0_out] [client1_out] ... [clientN_out]
@ -14,6 +15,7 @@ Once the broker mapped a page, it flags it save for unmapping.
|________________________________/
\|/
[broker]
```
After the broker received a new message for clientN, (clientN_out->current_id
!= last_message->message_id) the broker will copy the message content to its
@ -26,6 +28,7 @@ message in its queue. The LLMP_TAG_END_PAGE_V1 buf contains the new string to
access the shared map. The clients then switch over to read from that new
current map.
```text
[broker]
|
[current_broadcast_map]
@ -36,6 +39,7 @@ current map.
| | |
\|/ \|/ \|/
[client0] [client1] ... [clientN]
```
In the future, if we need zero copy, the current_broadcast_map could instead
list the client_out_map ID an offset for each message. In that case, the clients

View File

@ -232,7 +232,7 @@ impl Lehmer64Rand {
}
/// Extremely quick rand implementation
/// see https://arxiv.org/pdf/2002.11331.pdf
/// see <https://arxiv.org/pdf/2002.11331.pdf>
#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize)]
pub struct RomuTrioRand {
x_state: u64,
@ -274,7 +274,7 @@ impl Rand for RomuTrioRand {
}
}
/// see https://arxiv.org/pdf/2002.11331.pdf
/// see <https://arxiv.org/pdf/2002.11331.pdf>
#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize)]
pub struct RomuDuoJrRand {
x_state: u64,