#include <PartitionTable.h>

Collaboration diagram for Storage::PartitionTable:
[legend]

Public Member Functions

 PartitionTable (Device &device)
 
Partition find (const String &name) const
 Find partition by name. More...
 
Partition find (uint32_t address) const
 Find partition containing the given address. More...
 
Partition findOta (uint8_t index)
 Find the n'th OTA partition. More...
 
Iterator begin () const
 
Iterator end () const
 
uint8_t count () const
 
Devicedevice () const
 
Partition operator[] (unsigned index) const
 
Partition search

Find partitions based on one or more parameters

Parameters
typePartition type
subtypePartition sub-type
Return values
IteratorForward-iterator for matching partitions
Iterator find (Partition::Type type=Partition::Type::any, uint8_t subType=Partition::SubType::any) const
 
template<typename T >
Iterator find (T subType) const
 

Protected Member Functions

void load (const esp_partition_info_t *entry, unsigned count)
 

Protected Attributes

friend Device
 
DevicemDevice
 
std::unique_ptr< Partition::Info[]> mEntries
 
uint8_t mCount {0}
 

Constructor & Destructor Documentation

◆ PartitionTable()

Storage::PartitionTable::PartitionTable ( Device device)
inline

Member Function Documentation

◆ begin()

Iterator Storage::PartitionTable::begin ( ) const
inline

◆ count()

uint8_t Storage::PartitionTable::count ( ) const
inline

◆ device()

Device& Storage::PartitionTable::device ( ) const
inline

◆ end()

Iterator Storage::PartitionTable::end ( ) const
inline

◆ find() [1/4]

Iterator Storage::PartitionTable::find ( Partition::Type  type = Partition::Type::any,
uint8_t  subType = Partition::SubType::any 
) const
inline

◆ find() [2/4]

template<typename T >
Iterator Storage::PartitionTable::find ( subType) const
inline

◆ find() [3/4]

Partition Storage::PartitionTable::find ( const String name) const
inline

Find partition by name.

Parameters
NameName to search for, case-sensitive
Return values
PartitionNames are unique so at most only one match

◆ find() [4/4]

Partition Storage::PartitionTable::find ( uint32_t  address) const
inline

Find partition containing the given address.

Parameters
addressAddress to search for
Return values
Partition

◆ findOta()

Partition Storage::PartitionTable::findOta ( uint8_t  index)
inline

Find the n'th OTA partition.

◆ load()

void Storage::PartitionTable::load ( const esp_partition_info_t entry,
unsigned  count 
)
protected

◆ operator[]()

Partition Storage::PartitionTable::operator[] ( unsigned  index) const
inline

Member Data Documentation

◆ Device

friend Storage::PartitionTable::Device
protected

◆ mCount

uint8_t Storage::PartitionTable::mCount {0}
protected

◆ mDevice

Device& Storage::PartitionTable::mDevice
protected

◆ mEntries

std::unique_ptr<Partition::Info[]> Storage::PartitionTable::mEntries
protected

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