etl/docs/iterators/fixed_iterator.md
Roland Reichwein 08b9c371a0
Various fixes and cleanup (#1507)
* Fix histogram test

Use different Start index so skipped start_index copy would not get
unnoticed in the test.

* Fix several test_vector_* for valid data

Instead of comparing the moved-from data which is invalid, compare with
the valid initial_data.

* Fix test_vector to check for the correct iterator position after erase

This was done before, but a recent change dropped it.

* Fix bit_stream: Guard nbits > 0 to prevent division by zero

* Cleanup

---------

Co-authored-by: John Wellbelove <jwellbelove@users.noreply.github.com>
2026-07-20 11:19:41 +02:00

1.5 KiB

title
fixed_iterator

{{< callout type="info">}} Header: fixed_iterator.h
Since: TBC
{{< /callout >}}

An iterator where increments and decrements are null operations.
Can be used to copy to or from a fixed address such as a register.

Constructor

template <typename TIterator>
etl::fixed_iterator();
template <typename TIterator>
etl::fixed_iterator(TIterator it);
template <typename TIterator>
etl::fixed_iterator(const etl::fixed_iterator&);

Access

Titerator get() const;

Description
Get the internal iterator.

void get(TIterator it);

Description
Set the iterator.

Operators

typename etl::iterator_traits<TIterator>::value_type operator *()
const typename etl::iterator_traits<TIterator>::value_type operator *() const

Description
Dereference operators


TIterator operator ->()
const TIterator operator ->() const

Description
Member dereference operators


operator TIterator() const

Description
Conversion operator

Example

etl::vector<char, 32> buffer;

const char* UART_READ  = (const char*) 0x1000;
const char* UART_WRITE = (const char*) 0x1001;

etl::fixed_iterator<char*> uart_read(UART_READ);
etl::fixed_iterator<char*> uart_write(UART_WRITE);

// Read 20 characters from the port.
std::copy_n(uart_read, 20, std::back_inserter(buffer));

// Write the buffer of characters to the port.
std::copy(buffer.begin(), buffer.end(), uart_write);