Struct binate::frame::codec::KeepaliveFrame

pub struct KeepaliveFrame { /* fields omitted */ }

This is supported on crate feature frame only.

The keepalive frame.

Frame Contents

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         Stream ID = 0                         |
+-----------+-+-+-+-------------+-------------------------------+
|Frame Type |0|0|R|    Flags    |
+-----------+-+-+-+-------------+-------------------------------+
|0|                  Last Received Position                     |
+                                                               +
|                                                               |
+---------------------------------------------------------------+
                             Data

Implementations

impl KeepaliveFrame

pub const STREAM_ID: u32

KEEPALIVE frames MUST always use Stream ID 0 as they pertain to the Connection.

pub const TYPE: FrameType

Type of this frame.

pub fn new(
    last_received_position: u64,
    data: Option<Bytes>,
    respond: bool
) -> Self

Create a new Keepalive frame.

• last_received_position MUST be <= MAX_U63.

pub fn last_received_position(&self) -> u64

Returns the last received position of this frame.

pub fn data(&self) -> Option<&Bytes>

Returns the data attached to this frame, if any.

pub fn is_respond(&self) -> bool

Returns true if this frame has the Respond flag set.

Trait Implementations

impl Clone for KeepaliveFrame

fn clone(&self) -> KeepaliveFrame

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeepaliveFrame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decode for KeepaliveFrame

type Value = Self

The value decoded into.

fn decode<B: Buf>(
    buf: &mut B,
    stream_id: u32,
    flags: Flags
) -> Result<Self::Value, DecodeError>

Decodes the given bytes into a frame.

impl Encode for KeepaliveFrame

fn encode(&self, buf: &mut BytesMut)

Encodes self into bytes.

fn len(&self) -> usize

Returns the length (in bytes) of this value.

fn is_empty(&self) -> bool

Returns whether this value is empty.

fn to_bytes(&self) -> Bytes

Encodes self into bytes.

impl PartialEq<KeepaliveFrame> for KeepaliveFrame

fn eq(&self, other: &KeepaliveFrame) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &KeepaliveFrame) -> bool

This method tests for !=.

impl Eq for KeepaliveFrame

impl StructuralEq for KeepaliveFrame

impl StructuralPartialEq for KeepaliveFrame