word.h File Reference

#include <algorithm>
#include <optional>
#include <string>
#include <string_view>
#include "faker-cxx/export.h"
#include "faker-cxx/helper.h"
#include "faker-cxx/types/locale.h"

Include dependency graph for word.h:

Go to the source code of this file.

Namespaces
namespace	faker
namespace	faker::word

Functions
FAKER_CXX_EXPORT std::string_view	faker::word::sample (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random .
FAKER_CXX_EXPORT std::string	faker::word::words (unsigned numberOfWords=1, Locale locale=Locale::en_US)
	Returns a string containing a number of space separated random words.
FAKER_CXX_EXPORT std::string_view	faker::word::adjective (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random adjective.
FAKER_CXX_EXPORT std::string_view	faker::word::adjectiveLocale (unsigned length=0, Locale locale=Locale::en_US)
	Returns a random adjective, using locale.
FAKER_CXX_EXPORT std::string_view	faker::word::adverb (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random adverb.
FAKER_CXX_EXPORT std::string_view	faker::word::conjunction (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random conjunction.
FAKER_CXX_EXPORT std::string_view	faker::word::interjection (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random interjection.
FAKER_CXX_EXPORT std::string_view	faker::word::noun (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random noun.
FAKER_CXX_EXPORT std::string_view	faker::word::preposition (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random preposition.
FAKER_CXX_EXPORT std::string_view	faker::word::verb (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random verb.
template<std::ranges::range Range>
auto	faker::word::sortedSizeRandomElement (std::optional< unsigned int > length, Range &&range) -> decltype(auto)
	Returns random element of length.