trace::SpanContextKeyValueIterable Class Reference

Detailed Description

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

Definition at line 18 of file includes/opentelemetry/trace/span_context_kv_iterable.h.

Inheritance diagram for trace::SpanContextKeyValueIterable:

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

Constructor & Destructor Documentation

~SpanContextKeyValueIterable() [1/2]

virtual trace::SpanContextKeyValueIterable::~SpanContextKeyValueIterable ( )

virtualdefault

~SpanContextKeyValueIterable() [2/2]

virtual trace::SpanContextKeyValueIterable::~SpanContextKeyValueIterable ( )

virtualdefault

Member Function Documentation

ForEachKeyValue() [1/2]

virtual bool trace::SpanContextKeyValueIterable::ForEachKeyValue ( nostd::function_ref< bool(SpanContext, const common::KeyValueIterable &)>  callback ) const

pure virtualnoexcept

Iterate over SpanContext/key-value pairs.

Parameters

callback

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

Returns

true if every SpanContext/key-value pair was iterated over

Implemented in trace::NullSpanContext, trace::NullSpanContext, trace::SpanContextKeyValueIterableView< T >, and trace::SpanContextKeyValueIterableView< T >.

ForEachKeyValue() [2/2]

virtual bool trace::SpanContextKeyValueIterable::ForEachKeyValue ( nostd::function_ref< bool(SpanContext, const common::KeyValueIterable &)>  callback ) const

pure virtualnoexcept

Iterate over SpanContext/key-value pairs.

Parameters

callback

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

Returns

true if every SpanContext/key-value pair was iterated over

Implemented in trace::NullSpanContext, trace::NullSpanContext, trace::SpanContextKeyValueIterableView< T >, and trace::SpanContextKeyValueIterableView< T >.

size() [1/2]

virtual size_t trace::SpanContextKeyValueIterable::size ( ) const

pure virtualnoexcept

Returns

the number of key-value pairs

Implemented in trace::SpanContextKeyValueIterableView< T >, trace::SpanContextKeyValueIterableView< T >, trace::NullSpanContext, and trace::NullSpanContext.

size() [2/2]

virtual size_t trace::SpanContextKeyValueIterable::size ( ) const

pure virtualnoexcept

Returns

the number of key-value pairs

Implemented in trace::SpanContextKeyValueIterableView< T >, trace::SpanContextKeyValueIterableView< T >, trace::NullSpanContext, and trace::NullSpanContext.

---

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

• includes/opentelemetry/trace/span_context_kv_iterable.h