Struct binate::frame::codec::LeaseFrame

pub struct LeaseFrame { /* fields omitted */ }

This is supported on crate feature frame only.

The lease frame.

Lease frames MAY be sent by the client-side or server-side Responders and inform the Requester that it may send Requests for a period of time and how many it may send during that duration.

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|M|     Flags     |
+-----------+-+-+---------------+-------------------------------+
|0|                       Time-To-Live                          |
+---------------------------------------------------------------+
|0|                     Number of Requests                      |
+---------------------------------------------------------------+
                            Metadata

Implementations

impl LeaseFrame

pub const STREAM_ID: u32

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

pub fn new(ttl: u32, number_of_requests: u32, metadata: Option<Bytes>) -> Self

Create a new Lease frame.

• The ttl (Time to Live) is measured in milliseconds.
• Both ttl and number_of_requests MUST be <= MAX_U31.

pub fn ttl(&self) -> Duration

Returns the validity time (in milliseconds) of LEASE from time of reception.

pub fn number_of_requests(&self) -> u32

Returns the number of requests that may be sent until next LEASE.

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

Returns the metadata attached to this frame, if any.

Trait Implementations

impl Clone for LeaseFrame

fn clone(&self) -> LeaseFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LeaseFrame

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

Formats the value using the given formatter.

impl Decode for LeaseFrame

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 LeaseFrame

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

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

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

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

This method tests for !=.

impl Eq for LeaseFrame

impl StructuralEq for LeaseFrame

impl StructuralPartialEq for LeaseFrame