Radish alpha
h
Radicle Heartwood Protocol & Stack
Radicle
Git (anonymous pull)
Log in to clone via SSH
protocol: fix `Frame` docstring
Fintan Halpenny committed 9 months ago
commit 010d5134e8fae35e9e4f179d2929e41a20a93d30
parent 3c5668edd22ae4b9a085220d6be552f944ccb038
1 file changed +2 -0
modified crates/radicle-protocol/src/wire/frame.rs
@@ -184,6 +184,7 @@ impl TryFrom<u8> for StreamKind {

/// Protocol frame.
///
+
/// ```text
///  0                   1                   2                   3
///  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -193,6 +194,7 @@ impl TryFrom<u8> for StreamKind {
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
/// |                     Data                                   ...| Data (variable size)
/// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
/// ```
#[derive(Debug, PartialEq, Eq)]
pub struct Frame<M = Message> {
    /// The protocol version.