Struct Lease 

pub struct Lease {
    pub time_to_live: u32,
    pub number_of_requests: u32,
    pub metadata: BytesMut,
    /* private fields */
}

LEASE Frame (0x02)

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. See Lease Semantics for more information.

The last received LEASE frame overrides all previous LEASE frame values.

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

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

Notes

• A Responder implementation MAY stop all further requests by sending a Lease with a value of 0 for Number of Requests or Time-To-Live.

• When a Lease expires due to time, the value of the Number of Requests that a Requester may make is implicitly 0.

• This frame only supports Metadata, so the Metadata Length header MUST NOT be included, even if the FrameFlags::METADATA flag is set true.

Fields

time_to_live: u32

Time-To-Live (TTL)

Unsigned 31-bit integer of Time (in milliseconds) for validity of Lease from time of reception. Value MUST be > 0.

number_of_requests: u32

Number of Requests

Unsigned 31-bit integer of Number of Requests that may be sent until next Lease. Value MUST be > 0.

metadata: BytesMut

Lease metadata

Implementations

impl Lease

pub fn set_metadata(&mut self, metadata: BytesMut)

Sets the value of Lease.metadata

pub const fn builder() -> LeaseBuilder

Creates a builder to builder a frame of this type.

Trait Implementations

impl Clone for Lease

fn clone(&self) -> Lease

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lease

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

Formats the value using the given formatter.

impl Decoder for Lease

type Error = Error

The type of error that can occur if decoding fails.

fn decode(__buf: &mut BytesMut) -> Result<Self, Self::Error>

Decodes a value from the given buffer.

fn has_enough_bytes(_buf: &BytesMut) -> bool

Returns true if the given buffer can be decoded.

impl Encoder for Lease

type Error = Error

The type of error that can occur if encoding fails.

fn encode(input: &Self, __buf: &mut BytesMut) -> Result<(), Self::Error>

Encodes the given input into the output buffer.

fn size_of(input: &Self) -> usize

Returns the number of bytes required to encode the given input.

impl FrameVariant for Lease

const FLAGS_MASK: FrameFlags

Mask that flags of a variant must be in.

fn flags(&self) -> FrameFlags

Gets the flags of the variant.

const REQUIRED_FLAGS: FrameFlags = _

Flags that must be set for a variant.

impl From<Lease> for Frame

fn from(value: Lease) -> Self

Converts to this type from the input type.