ESPHome 2026.3.0-dev
Loading...
Searching...
No Matches
esphome::online_image::DownloadBuffer Class Reference

Buffer for managing downloaded data. More...

#include <download_buffer.h>

Public Member Functions

 DownloadBuffer (size_t size)
 
 ~DownloadBuffer ()
 
uint8_t * data (size_t offset=0)
 
uint8_t * append ()
 
size_t unread () const
 
size_t size () const
 
size_t free_capacity () const
 
size_t read (size_t len)
 
size_t write (size_t len)
 
void reset ()
 
size_t resize (size_t size)
 

Protected Attributes

uint8_t * buffer_
 
size_t size_
 
size_t unread_
 Total number of downloaded bytes not yet read.
 

Detailed Description

Buffer for managing downloaded data.

This class provides a buffer for downloading data with tracking of unread bytes and dynamic resizing capabilities.

Definition at line 15 of file download_buffer.h.

Constructor & Destructor Documentation

◆ DownloadBuffer()

esphome::online_image::DownloadBuffer::DownloadBuffer ( size_t size)

Definition at line 9 of file download_buffer.cpp.

◆ ~DownloadBuffer()

esphome::online_image::DownloadBuffer::~DownloadBuffer ( )
inline

Definition at line 18 of file download_buffer.h.

Member Function Documentation

◆ append()

uint8_t * esphome::online_image::DownloadBuffer::append ( )
inline

Definition at line 24 of file download_buffer.h.

◆ data()

uint8_t * esphome::online_image::DownloadBuffer::data ( size_t offset = 0)

Definition at line 19 of file download_buffer.cpp.

◆ free_capacity()

size_t esphome::online_image::DownloadBuffer::free_capacity ( ) const
inline

Definition at line 28 of file download_buffer.h.

◆ read()

size_t esphome::online_image::DownloadBuffer::read ( size_t len)

Definition at line 27 of file download_buffer.cpp.

◆ reset()

void esphome::online_image::DownloadBuffer::reset ( )
inline

Definition at line 36 of file download_buffer.h.

◆ resize()

size_t esphome::online_image::DownloadBuffer::resize ( size_t size)

Definition at line 37 of file download_buffer.cpp.

◆ size()

size_t esphome::online_image::DownloadBuffer::size ( ) const
inline

Definition at line 27 of file download_buffer.h.

◆ unread()

size_t esphome::online_image::DownloadBuffer::unread ( ) const
inline

Definition at line 26 of file download_buffer.h.

◆ write()

size_t esphome::online_image::DownloadBuffer::write ( size_t len)
inline

Definition at line 31 of file download_buffer.h.

Field Documentation

◆ buffer_

uint8_t* esphome::online_image::DownloadBuffer::buffer_
protected

Definition at line 40 of file download_buffer.h.

◆ size_

size_t esphome::online_image::DownloadBuffer::size_
protected

Definition at line 41 of file download_buffer.h.

◆ unread_

size_t esphome::online_image::DownloadBuffer::unread_
protected

Total number of downloaded bytes not yet read.

Definition at line 43 of file download_buffer.h.


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