common::KeyValueIterable Class Reference

Detailed Description

Supports internal iteration over a collection of key-value pairs.

Definition at line 17 of file includes/opentelemetry/common/key_value_iterable.h.

Inheritance diagram for common::KeyValueIterable:

Public Member Functions
virtual	~KeyValueIterable ()=default
virtual bool	ForEachKeyValue (nostd::function_ref< bool(nostd::string_view, common::AttributeValue)> callback) const noexcept=0
	Iterate over key-value pairs. More...
virtual size_t	size () const noexcept=0
virtual	~KeyValueIterable ()=default
virtual bool	ForEachKeyValue (nostd::function_ref< bool(nostd::string_view, common::AttributeValue)> callback) const noexcept=0
	Iterate over key-value pairs. More...
virtual size_t	size () const noexcept=0

Constructor & Destructor Documentation

~KeyValueIterable() [1/2]

virtual common::KeyValueIterable::~KeyValueIterable ( )

virtualdefault

~KeyValueIterable() [2/2]

virtual common::KeyValueIterable::~KeyValueIterable ( )

virtualdefault

Member Function Documentation

ForEachKeyValue() [1/2]

virtual bool common::KeyValueIterable::ForEachKeyValue ( nostd::function_ref< bool(nostd::string_view, common::AttributeValue)>  callback ) const

pure virtualnoexcept

Iterate over key-value pairs.

Parameters

callback

a callback to invoke for each key-value. If the callback returns false, the iteration is aborted.

Returns

true if every key-value pair was iterated over

Implemented in common::NoopKeyValueIterable, common::NoopKeyValueIterable, common::KeyValueIterableView< T >, and common::KeyValueIterableView< T >.

ForEachKeyValue() [2/2]

virtual bool common::KeyValueIterable::ForEachKeyValue ( nostd::function_ref< bool(nostd::string_view, common::AttributeValue)>  callback ) const

pure virtualnoexcept

Iterate over key-value pairs.

Parameters

callback

a callback to invoke for each key-value. If the callback returns false, the iteration is aborted.

Returns

true if every key-value pair was iterated over

Implemented in common::NoopKeyValueIterable, common::NoopKeyValueIterable, common::KeyValueIterableView< T >, and common::KeyValueIterableView< T >.

size() [1/2]

virtual size_t common::KeyValueIterable::size ( ) const

pure virtualnoexcept

Returns

the number of key-value pairs

Implemented in common::KeyValueIterableView< T >, common::KeyValueIterableView< T >, common::NoopKeyValueIterable, and common::NoopKeyValueIterable.

size() [2/2]

virtual size_t common::KeyValueIterable::size ( ) const

pure virtualnoexcept

Returns

the number of key-value pairs

Implemented in common::KeyValueIterableView< T >, common::KeyValueIterableView< T >, common::NoopKeyValueIterable, and common::NoopKeyValueIterable.

---

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

• includes/opentelemetry/common/key_value_iterable.h