Struct binate::frame::codec::ResumeFrame

pub struct ResumeFrame { /* fields omitted */ }

This is supported on crate feature frame only.

The resume frame.

Frame Contents

The general format for a Resume frame is given below.

 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|    Flags      |
+-------------------------------+-------------------------------+
|        Major Version          |         Minor Version         |
+-------------------------------+-------------------------------+
|         Token Length          | Resume Identification Token  ...
+---------------------------------------------------------------+
|0|                                                             |
+                 Last Received Server Position                 +
|                                                               |
+---------------------------------------------------------------+
|0|                                                             |
+                First Available Client Position                +
|                                                               |
+---------------------------------------------------------------+

Implementations

impl ResumeFrame

pub const STREAM_ID: u32

RESUME frames MUST always use Stream ID 0 as they pertain to the connection.

pub fn new(
    version: Version,
    resume_token: Bytes,
    last_received_server_position: u64,
    first_available_client_position: u64
) -> Self

Create a new Resume frame.

• The length of resume_token MUST be <= 65,535 bytes long.
• Both last_received_server_position and first_available_client_position MUST be <= MAX_U63.

pub fn version(&self) -> Version

Returns the version field of this frame.

pub fn resume_token(&self) -> &Bytes

Returns the resume identification token.

pub fn last_received_server_position(&self) -> u64

Returns the last implied position the client received from the server.

pub fn first_available_client_position(&self) -> u64

Returns the earliest position that the client can rewind back to prior to resending frames.

Trait Implementations

impl Clone for ResumeFrame

fn clone(&self) -> ResumeFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResumeFrame

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

Formats the value using the given formatter.

impl Decode for ResumeFrame

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 ResumeFrame

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<ResumeFrame> for ResumeFrame

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

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

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

This method tests for !=.

impl Eq for ResumeFrame

impl StructuralEq for ResumeFrame

impl StructuralPartialEq for ResumeFrame