ESPHome 2026.2.3
Loading...
Searching...
No Matches
esphome::api::ProtoVarInt Class Reference

Representation of a VarInt - in ProtoBuf should be 64bit but we only use 32bit. More...

#include <proto.h>

Public Member Functions

 ProtoVarInt ()
 
 ProtoVarInt (uint64_t value)
 
constexpr uint16_t as_uint16 () const
 
constexpr uint32_t as_uint32 () const
 
constexpr uint64_t as_uint64 () const
 
constexpr bool as_bool () const
 
constexpr int32_t as_int32 () const
 
constexpr int64_t as_int64 () const
 
constexpr int32_t as_sint32 () const
 
constexpr int64_t as_sint64 () const
 

Static Public Member Functions

static optional< ProtoVarIntparse (const uint8_t *buffer, uint32_t len, uint32_t *consumed)
 Parse a varint from buffer. consumed must be a valid pointer (not null).
 

Protected Attributes

uint64_t value_
 

Detailed Description

Representation of a VarInt - in ProtoBuf should be 64bit but we only use 32bit.

Definition at line 101 of file proto.h.

Constructor & Destructor Documentation

◆ ProtoVarInt() [1/2]

esphome::api::ProtoVarInt::ProtoVarInt ( )
inline

Definition at line 103 of file proto.h.

◆ ProtoVarInt() [2/2]

esphome::api::ProtoVarInt::ProtoVarInt ( uint64_t value)
inlineexplicit

Definition at line 104 of file proto.h.

Member Function Documentation

◆ as_bool()

bool esphome::api::ProtoVarInt::as_bool ( ) const
inlineconstexpr

Definition at line 146 of file proto.h.

◆ as_int32()

int32_t esphome::api::ProtoVarInt::as_int32 ( ) const
inlineconstexpr

Definition at line 147 of file proto.h.

◆ as_int64()

int64_t esphome::api::ProtoVarInt::as_int64 ( ) const
inlineconstexpr

Definition at line 151 of file proto.h.

◆ as_sint32()

int32_t esphome::api::ProtoVarInt::as_sint32 ( ) const
inlineconstexpr

Definition at line 155 of file proto.h.

◆ as_sint64()

int64_t esphome::api::ProtoVarInt::as_sint64 ( ) const
inlineconstexpr

Definition at line 159 of file proto.h.

◆ as_uint16()

uint16_t esphome::api::ProtoVarInt::as_uint16 ( ) const
inlineconstexpr

Definition at line 143 of file proto.h.

◆ as_uint32()

uint32_t esphome::api::ProtoVarInt::as_uint32 ( ) const
inlineconstexpr

Definition at line 144 of file proto.h.

◆ as_uint64()

uint64_t esphome::api::ProtoVarInt::as_uint64 ( ) const
inlineconstexpr

Definition at line 145 of file proto.h.

◆ parse()

static optional< ProtoVarInt > esphome::api::ProtoVarInt::parse ( const uint8_t * buffer,
uint32_t len,
uint32_t * consumed )
inlinestatic

Parse a varint from buffer. consumed must be a valid pointer (not null).

Definition at line 107 of file proto.h.

Field Documentation

◆ value_

uint64_t esphome::api::ProtoVarInt::value_
protected

Definition at line 165 of file proto.h.


The documentation for this class was generated from the following file: