Class representing a hint to be passed to a database operation. More...

#include <hint.hpp>

Public Member Functions
	hint (bsoncxx::document::view_or_value index)
	Constructs a new hint. More...

	hint (bsoncxx::string::view_or_value index)
	Constructs a new hint. More...

bsoncxx::types::bson_value::view	to_value () const
	Returns a types::bson_value::view representing this hint. More...

	operator bsoncxx::types::bson_value::view () const
	Returns a types::bson_value::view representing this hint. More...

Related Functions
(Note that these are not member functions.)
bool	operator== (std::string index, const hint &index_hint)
	Convenience methods to compare for equality against an index name. More...

bool	operator== (bsoncxx::document::view index, const hint &index_hint)
	Convenience methods to compare for equality against an index document. More...


bool	operator!= (const hint &index_hint, std::string index)
	Convenience methods to compare for inequality against an index name. More...


bool	operator!= (const hint &index_hint, bsoncxx::document::view index)
	Convenience methods to compare for equality against an index document. More...

bool	operator== (const hint &index_hint, std::string index)
	Compare this hint to a string for (in)-equality.

bool	operator== (const hint &index_hint, bsoncxx::document::view index)
	Compare this hint to a string for (in)-equality.

Detailed Description

Class representing a hint to be passed to a database operation.

Constructor & Destructor Documentation

◆ hint() [1/2]

mongocxx::hint::hint ( bsoncxx::document::view_or_value index )

Constructs a new hint.

Note: this constructor is purposefully not explicit, to allow conversion from either document::view or document::value to view_or_value.

Parameters

index Document view or value representing the index to be used.

◆ hint() [2/2]

mongocxx::hint::hint ( bsoncxx::string::view_or_value index )

explicit

Constructs a new hint.

Parameters

index String representing the name of the index to be used.

Member Function Documentation

◆ operator bsoncxx::types::bson_value::view()

mongocxx::hint::operator bsoncxx::types::bson_value::view ( ) const

Returns a types::bson_value::view representing this hint.

Returns: Hint, as a types::bson_value::view. The caller must ensure that the returned object not outlive the hint object that it was created from.

◆ to_value()

bsoncxx::types::bson_value::view mongocxx::hint::to_value ( ) const

Returns a types::bson_value::view representing this hint.

Returns: Hint, as a types::bson_value::view. The caller must ensure that the returned object not outlive the hint object that it was created from.

Friends And Related Function Documentation

◆ operator!=() [1/2]

bool operator!=	(	const hint &	index_hint,
		bsoncxx::document::view	index
	)

Return true if this hint contains an index document that matches.

◆ operator!=() [2/2]

bool operator!=	(	const hint &	index_hint,
		std::string	index
	)

Return true if this hint contains an index name that matches.

◆ operator==() [1/2]

bool operator==	(	bsoncxx::document::view	index,
		const hint &	index_hint
	)