An iterator for a set of options for a compressor. More...
#include <stdbool.h>
Include dependency graph for pressio_options_iter.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Functions | |
| struct pressio_options_iter * | pressio_options_get_iter (struct pressio_options const *options) |
| bool | pressio_options_iter_has_value (struct pressio_options_iter *iter) |
| void | pressio_options_iter_next (struct pressio_options_iter *iter) |
| char const * | pressio_options_iter_get_key (struct pressio_options_iter *const iter) |
| struct pressio_option * | pressio_options_iter_get_value (struct pressio_options_iter *const iter) |
| void | pressio_options_iter_free (struct pressio_options_iter *const iter) |
Detailed Description
An iterator for a set of options for a compressor.
Function Documentation
◆ pressio_options_get_iter()
| struct pressio_options_iter * pressio_options_get_iter | ( | struct pressio_options const * | options | ) |
Get an iterator over all keys the use of any of the pressio_options_set* functions invalidates the iterator
- Returns
- an iterator over all keys
◆ pressio_options_iter_free()
| void pressio_options_iter_free | ( | struct pressio_options_iter *const | iter | ) |
- Parameters
-
[in] iter the iterator to free frees memory associated with the iterator
◆ pressio_options_iter_get_key()
| char const * pressio_options_iter_get_key | ( | struct pressio_options_iter *const | iter | ) |
get the key for the current position of the iterator
- Parameters
-
[in] iter the iterator to get the current value for
- Returns
- a non-owning pointer to the key name associated with the current position of the iterator
◆ pressio_options_iter_get_value()
| struct pressio_option * pressio_options_iter_get_value | ( | struct pressio_options_iter *const | iter | ) |
get the value for the current position of the iterator
- Parameters
-
[in] iter the iterator to get the current value for
- Returns
- a owning pointer to the value associated with the current position of the iterator
◆ pressio_options_iter_has_value()
| bool pressio_options_iter_has_value | ( | struct pressio_options_iter * | iter | ) |
Returns true if the current position has a value
- Parameters
-
[in] iter to check if it has a next value
- Returns
- true if the current iterator position has a value
◆ pressio_options_iter_next()
| void pressio_options_iter_next | ( | struct pressio_options_iter * | iter | ) |
advances the iterator to the next entry
- Parameters
-
[in] iter the iterator to advance
