Storage::StreamDevice Class Reference

Read-only partition on a stream object. More...

#include <StreamDevice.h>

Inheritance diagram for Storage::StreamDevice:

Collaboration diagram for Storage::StreamDevice:

Public Member Functions
	StreamDevice (IDataSourceStream *stream, size_t size)
	StreamDevice (IDataSourceStream *stream)
Type	getType () const override
	Obtain device type. More...
bool	read (storage_size_t address, void *buffer, size_t len) override
	Read data from the storage device. More...
bool	write (storage_size_t address, const void *data, size_t len) override
	Write data to the storage device. More...
bool	erase_range (storage_size_t address, storage_size_t len) override
	Erase a region of storage in preparation for writing. More...
Public Member Functions inherited from Storage::Device
	Device ()
	~Device ()
bool	operator== (const String &name) const
const PartitionTable &	partitions () const
	Provide read-only access to partition table. More...
PartitionTable &	editablePartitions ()
	Provide full access to partition table. More...
bool	loadPartitions (uint32_t tableOffset)
	Load partition table entries @tableOffset Location of partition table to read. More...
bool	loadPartitions (Device &source, uint32_t tableOffset)
	Load partition table entries from another table. More...
virtual String	getName () const =0
	Obtain unique device name. More...
virtual uint32_t	getId () const
	Obtain device ID. More...
virtual size_t	getBlockSize () const =0
	Obtain smallest allocation unit for erase operations. More...
virtual storage_size_t	getSize () const =0
	Obtain addressable size of this device. More...
virtual uint16_t	getSectorSize () const
	Get sector size, the unit of allocation for block-access devices. More...
virtual storage_size_t	getSectorCount () const
	Obtain total number of sectors on this device. More...
virtual bool	sync ()
	Flush any pending writes to the physical media. More...
size_t	printTo (Print &p) const
Public Member Functions inherited from LinkedObjectTemplate< Device >
Device *	getNext () const
bool	insertAfter (Device *object)
Iterator	begin () const
Iterator	end () const
Iterator	cbegin () const
Iterator	cend () const
Public Member Functions inherited from LinkedObject
virtual	~LinkedObject ()
virtual LinkedObject *	next () const
bool	insertAfter (LinkedObject *object)
bool	operator== (const LinkedObject &other) const
bool	operator!= (const LinkedObject &other) const

Static Public Member Functions
static String	nameOf (IDataSourceStream *stream)

Additional Inherited Members
Public Types inherited from Storage::Device
enum	Type : uint8_t { Type::XX }
	Storage type. More...
using	List = LinkedObjectListTemplate< Device >
using	OwnedList = OwnedLinkedObjectListTemplate< Device >
Public Types inherited from LinkedObjectTemplate< Device >
using	Iterator = IteratorTemplate< Device, Device *, Device & >
using	ConstIterator = IteratorTemplate< const Device, const Device *, const Device & >
Static Public Attributes inherited from Storage::Device
static constexpr uint16_t	defaultSectorSize {512}
Protected Attributes inherited from Storage::Device
PartitionTable	mPartitions

Detailed Description

Read-only partition on a stream object.

Note

Writes not possible as streams always append data, cannot do random writes

Constructor & Destructor Documentation

StreamDevice() [1/2]

Storage::StreamDevice::StreamDevice ( IDataSourceStream *  stream, size_t  size  )

inline

StreamDevice() [2/2]

Storage::StreamDevice::StreamDevice ( IDataSourceStream *  stream )

inline

Member Function Documentation

erase_range()

bool Storage::StreamDevice::erase_range ( storage_size_t  address, storage_size_t  size  )

inlineoverridevirtual

Erase a region of storage in preparation for writing.

Parameters

address	Where to start erasing
size	Size of region to erase, in bytes

Return values

bool	true on success, false on error

Implements Storage::Device.

getType()

Type Storage::StreamDevice::getType ( ) const

inlineoverridevirtual

Obtain device type.

Implements Storage::Device.

nameOf()

static String Storage::StreamDevice::nameOf ( IDataSourceStream *  stream )

inlinestatic

read()

bool Storage::StreamDevice::read ( storage_size_t  address, void *  dst, size_t  size  )

inlineoverridevirtual

Read data from the storage device.

Parameters

address	Where to start reading
dst	Buffer to store data
size	Size of data to be read, in bytes.

Return values

bool	true on success, false on error

Implements Storage::Device.

write()

bool Storage::StreamDevice::write ( storage_size_t  address, const void *  src, size_t  size  )

inlineoverridevirtual

Write data to the storage device.

Parameters

address	Where to start writing
src	Data to write
size	Size of data to be written, in bytes.

Return values

bool	true on success, false on error

Implements Storage::Device.

---

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

• StreamDevice.h