Storage::PartitionTable Class Reference

#include <PartitionTable.h>

Inheritance diagram for Storage::PartitionTable:

Collaboration diagram for Storage::PartitionTable:

Public Member Functions
	PartitionTable (Device &device)
	operator bool () const
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) const
	Find the n'th OTA partition. More...
Iterator	begin () const
Iterator	end () const
Device &	device () const
Partition	add (const Partition::Info *info)
	Add new partition using given Info. More...
template<typename... Args>
Partition	add (const String &name, Partition::FullType type, Args... args)
void	clear ()
Partition search
Iterator	find (Partition::Type type=Partition::Type::any, uint8_t subType=Partition::SubType::any) const
	Find partitions based on one or more parameters. More...
Iterator	find (Partition::FullType fullType) const

Protected Member Functions
void	load (const esp_partition_info_t *entry, unsigned count)

Protected Attributes
friend	Device
friend	Iterator
Device &	mDevice
Partition::Info::OwnedList	mEntries

Constructor & Destructor Documentation

PartitionTable()

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

inline

Member Function Documentation

add() [1/2]

Partition Storage::PartitionTable::add ( const Partition::Info *  info )

inline

Add new partition using given Info.

Parameters

info	Must be allocated using new: Device will take ownership

Return values

Partition

Reference to the partition

add() [2/2]

template<typename... Args>

Partition Storage::PartitionTable::add ( const String &  name, Partition::FullType  type, Args...  args  )

inline

begin()

Iterator Storage::PartitionTable::begin ( ) const

inline

clear()

void Storage::PartitionTable::clear ( void  )

inline

device()

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

inline

end()

Iterator Storage::PartitionTable::end ( ) const

inline

find() [1/4]

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

inline

Find partition by name.

Parameters

Name	Name to search for, case-sensitive

Return values

Partition

Names are unique so at most only one match

find() [2/4]

Iterator Storage::PartitionTable::find ( Partition::FullType  fullType ) const

inline

find() [3/4]

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

inline

Find partitions based on one or more parameters.

Parameters

type	Partition type
subtype	Partition sub-type

Return values

Iterator

Forward-iterator for matching partitions

find() [4/4]

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

inline

Find partition containing the given address.

Parameters

address

Address to search for

Return values

Partition

findOta()

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

inline

Find the n'th OTA partition.

load()

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

protected

operator bool()

Storage::PartitionTable::operator bool ( ) const

inlineexplicit

Member Data Documentation

Device

friend Storage::PartitionTable::Device

protected

Iterator

friend Storage::PartitionTable::Iterator

protected

mDevice

Device& Storage::PartitionTable::mDevice

protected

mEntries

Partition::Info::OwnedList Storage::PartitionTable::mEntries

protected

---

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

• PartitionTable.h