faker::word Namespace Reference

Functions
FAKER_CXX_EXPORT std::string_view	sample (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random .
FAKER_CXX_EXPORT std::string	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	adjective (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random adjective.
FAKER_CXX_EXPORT std::string_view	adjectiveLocale (unsigned length=0, Locale locale=Locale::en_US)
	Returns a random adjective, using locale.
FAKER_CXX_EXPORT std::string_view	adverb (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random adverb.
FAKER_CXX_EXPORT std::string_view	conjunction (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random conjunction.
FAKER_CXX_EXPORT std::string_view	interjection (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random interjection.
FAKER_CXX_EXPORT std::string_view	noun (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random noun.
FAKER_CXX_EXPORT std::string_view	preposition (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random preposition.
FAKER_CXX_EXPORT std::string_view	verb (std::optional< unsigned > length=std::nullopt, Locale locale=Locale::en_US)
	Returns a random verb.
template<std::ranges::range Range>
auto	sortedSizeRandomElement (std::optional< unsigned int > length, Range &&range) -> decltype(auto)
	Returns random element of length.

Function Documentation

adjective()

FAKER_CXX_EXPORT std::string_view faker::word::adjective	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random adjective.

Parameters

length	The expected length of the word. If no adjective with given length will be found or length is 0, it will return a random size adjective.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Adjective.

faker::word::adjective() // "complete"
faker::word::adjective(3) // "bad"

adjectiveLocale()

FAKER_CXX_EXPORT std::string_view faker::word::adjectiveLocale	(	unsigned	length = 0,
		Locale	locale = Locale::en_US )

Returns a random adjective, using locale.

Parameters

length	The expected length of the word. If no adjective with given length will be found or length is 0, it will return a random size adjective.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Adjective.

faker::word::adjective() // "complete"
faker::word::adjective(3) // "bad"

adverb()

FAKER_CXX_EXPORT std::string_view faker::word::adverb	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random adverb.

Parameters

length	The expected length of the word. If no adverb with given length will be found or length is 0, it will return a random size adverb.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Adverb.

faker::word::adverb() // "deliberately"
faker::word::adverb(5) // "almost"

conjunction()

FAKER_CXX_EXPORT std::string_view faker::word::conjunction	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random conjunction.

Parameters

length	The expected length of the word. If no conjunction with given length will be found or length is 0, it will return a random size conjunction.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Conjunction.

faker::word::conjunction() // "because"
faker::word::conjunction(6) // "indeed"

interjection()

FAKER_CXX_EXPORT std::string_view faker::word::interjection	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random interjection.

Parameters

length	The expected length of the word. If no interjection with given length is found or length is 0, it will return a random size interjection.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Interjection.

faker::word::interjection() // "psst"
faker::word::interjection(4) // "yuck"

noun()

FAKER_CXX_EXPORT std::string_view faker::word::noun	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random noun.

Parameters

length	The expected length of the word. If no noun with given length is found or length is 0, it will return a random size noun.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Noun.

faker::word::noun() // "pudding"
faker::word::noun(8) // "distance"

preposition()

FAKER_CXX_EXPORT std::string_view faker::word::preposition	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random preposition.

Parameters

length	The expected length of the word. If no preposition with given length is found or length is 0, it will return a random size preposition.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Preposition.

faker::word::preposition() // "besides"
faker::word::preposition(4) // "from"

sample()

FAKER_CXX_EXPORT std::string_view faker::word::sample	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random .

Parameters

length	The expected length of the . If no word with given length will be found or length is 0, it will return a random size word.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Random sample word.

faker::word::sample() // "protection"
faker::word::sample(5) // "spell"

sortedSizeRandomElement()

template<std::ranges::range Range>

auto faker::word::sortedSizeRandomElement	(	std::optional< unsigned int >	length,
		Range &&	range ) -> decltype(auto)

Returns random element of length.

Parameters

length	The length of the elements to be picked from
locale	The locale. Defaults to `Locale::en_US`.

@ range The range of elements

Returns

An element of the range value type

faker::word::sortedSizeRandomElement(3, {"hi, "hello", "hey"}) // "hey" - Since "hey" is the only element of length 3

verb()

FAKER_CXX_EXPORT std::string_view faker::word::verb	(	std::optional< unsigned >	length = std::nullopt,
		Locale	locale = Locale::en_US )

Returns a random verb.

Parameters

length	The expected length of the word. If no verb with given length is found or length is 0, it will return a random size verb.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Verb.

faker::word::verb() // "override"
faker::word::verb(9) // "stabilise"

words()

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.

Parameters

numberOfWords	The number of words to generate.
locale	The locale. Defaults to `Locale::en_US`.

Returns

Random words separated with spaces.

faker::word::words() // "protection"
faker::word::words(5) // "before hourly patiently dribble equal"