esphome::api::DumpBuffer Class Reference

Fixed-size buffer for message dumps - avoids heap allocation. More...

#include <proto.h>

Public Member Functions
	DumpBuffer ()
DumpBuffer &	append (const char *str)
DumpBuffer &	append (const char *str, size_t len)
DumpBuffer &	append (size_t n, char c)
DumpBuffer &	append_p (const char *str)
	Append a PROGMEM string (flash-safe on ESP8266, regular append on other platforms)
void	append_p_esp8266 (const char *str)
	Out-of-line ESP8266 PROGMEM append to avoid inlining strlen_P/memcpy_P at every call site.
const char *	c_str () const
size_t	size () const
char *	data ()
	Get writable buffer pointer for use with buf_append_printf.
size_t	pos () const
	Get current position for use with buf_append_printf.
void	set_pos (size_t pos)
	Update position after buf_append_printf call.

Static Public Attributes
static constexpr size_t	CAPACITY = 512

Detailed Description

Fixed-size buffer for message dumps - avoids heap allocation.

Sized to match the logger's default tx_buffer_size (512 bytes) since anything larger gets truncated anyway.

Definition at line 384 of file proto.h.

Constructor & Destructor Documentation

DumpBuffer()

esphome::api::DumpBuffer::DumpBuffer ( )

inline

Definition at line 389 of file proto.h.

Member Function Documentation

append() [1/3]

DumpBuffer & esphome::api::DumpBuffer::append ( const char * str )

inline

Definition at line 391 of file proto.h.

append() [2/3]

DumpBuffer & esphome::api::DumpBuffer::append ( const char * str, size_t len )

inline

Definition at line 398 of file proto.h.

append() [3/3]

DumpBuffer & esphome::api::DumpBuffer::append ( size_t n, char c )

inline

Definition at line 403 of file proto.h.

append_p()

DumpBuffer & esphome::api::DumpBuffer::append_p ( const char * str )

inline

Append a PROGMEM string (flash-safe on ESP8266, regular append on other platforms)

Definition at line 416 of file proto.h.

append_p_esp8266()

void esphome::api::DumpBuffer::append_p_esp8266

(

const char *

str

)

Out-of-line ESP8266 PROGMEM append to avoid inlining strlen_P/memcpy_P at every call site.

Definition at line 15 of file api_pb2_dump.cpp.

c_str()

const char * esphome::api::DumpBuffer::c_str ( ) const

inline

Definition at line 432 of file proto.h.

data()

char * esphome::api::DumpBuffer::data ( )

inline

Get writable buffer pointer for use with buf_append_printf.

Definition at line 436 of file proto.h.

pos()

size_t esphome::api::DumpBuffer::pos ( ) const

inline

Get current position for use with buf_append_printf.

Definition at line 438 of file proto.h.

set_pos()

void esphome::api::DumpBuffer::set_pos ( size_t pos )

inline

Update position after buf_append_printf call.

Definition at line 440 of file proto.h.

size()

size_t esphome::api::DumpBuffer::size ( ) const

inline

Definition at line 433 of file proto.h.

Field Documentation

CAPACITY

size_t esphome::api::DumpBuffer::CAPACITY = 512

staticconstexpr

Definition at line 387 of file proto.h.

---

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

• esphome/components/api/proto.h
• esphome/components/api/api_pb2_dump.cpp