bmqpi::DTSpan::BSLS_KEYWORD_FINAL Class Reference

#include <bmqpi_dtspan.h>

List of all members.

Public Types
typedef MapType::const_iterator	const_iterator
Public Member Functions
	Baggage (bslma::Allocator *allocator=0)
const_iterator	begin () const
const_iterator	end () const
bool	has (const bsl::string &key) const
bsl::string_view	get (const bsl::string &key, const bsl::string_view &dflt="") const
void	put (const bsl::string_view &key, const bsl::string_view &value)
bool	erase (const bsl::string &key)

---

Detailed Description

A set of key-values used to describe a DTSpan.

See Component bmqpi_dtspan

---

Member Typedef Documentation

typedef MapType::const_iterator bmqpi::DTSpan::BSLS_KEYWORD_FINAL::const_iterator

---

Member Function Documentation

bmqpi::DTSpan::BSLS_KEYWORD_FINAL::Baggage

(

bslma::Allocator *

allocator = 0

)

const_iterator bmqpi::DTSpan::BSLS_KEYWORD_FINAL::begin

(

)

const

Returns a const-iterator used to iterate over key-values.

const_iterator bmqpi::DTSpan::BSLS_KEYWORD_FINAL::end

(

)

const

Returns a const-iterator representing the end of key-values.

bool bmqpi::DTSpan::BSLS_KEYWORD_FINAL::has

(

const bsl::string &

key

)

const

Returns whether this object holds a value associated with the specified key.

bsl::string_view bmqpi::DTSpan::BSLS_KEYWORD_FINAL::get	(	const bsl::string &	key,
		const bsl::string_view &	dflt = ""
	)			const

Returns the value currently associated with key, or dflt if no associated value is currently held.

Beware that if key is not found and the returned string_view outlives dflt, then the string_view will reference a deallocated address.

void bmqpi::DTSpan::BSLS_KEYWORD_FINAL::put	(	const bsl::string_view &	key,
		const bsl::string_view &	value
	)

Stores the specified value associated with the specified key. Note that if such a key was already stored, then its associated value will be replaced by the supplied one.

bool bmqpi::DTSpan::BSLS_KEYWORD_FINAL::erase

(

const bsl::string &

key

)

Erases any value currently associated with key, and returns whether any such value was previously held.

---

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

• bmqpi_dtspan.h