internet.h

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <optional>
#include <string>
#include <string_view>
 
#include "faker-cxx/export.h"
#include "faker-cxx/types/locale.h"
 
namespace faker::internet
{
enum class HttpResponseType
{
    ClientError,
    Informational,
    Redirection,
    ServerError,
    Success,
};
 
enum class WebProtocol
{
    Http,
    Https
};
 
enum class IPv4Class
{
    A,
    B,
    C
};
 
struct FAKER_CXX_EXPORT PasswordOptions
{
    bool upperLetters = true;
    bool lowerLetters = true;
    bool numbers = true;
    bool symbols = true;
};
 
FAKER_CXX_EXPORT std::string username(std::optional<std::string> firstName = std::nullopt,
                                      std::optional<std::string> lastName = std::nullopt,
                                      Locale locale = Locale::en_US);
 
FAKER_CXX_EXPORT std::string email(std::optional<std::string> firstName = std::nullopt,
                                   std::optional<std::string> lastName = std::nullopt,
                                   std::optional<std::string> emailHost = std::nullopt);
 
FAKER_CXX_EXPORT std::string exampleEmail(std::optional<std::string> firstName = std::nullopt,
                                          std::optional<std::string> lastName = std::nullopt);
 
FAKER_CXX_EXPORT std::string password(int length = 16, const PasswordOptions& options = {});
 
enum class EmojiType
{
    Activity,
    Body,
    Flag,
    Food,
    Nature,
    Object,
    Person,
    Smiley,
    Symbol,
    Travel,
};
 
FAKER_CXX_EXPORT std::string_view emoji(std::optional<EmojiType> type = std::nullopt);
 
FAKER_CXX_EXPORT bool checkIfEmojiIsValid(const std::string& emojiToCheck);
 
FAKER_CXX_EXPORT std::string_view protocol();
 
FAKER_CXX_EXPORT std::string_view httpMethod();
 
FAKER_CXX_EXPORT unsigned httpStatusCode(std::optional<HttpResponseType> responseType = std::nullopt);
 
FAKER_CXX_EXPORT std::string_view httpRequestHeader();
 
FAKER_CXX_EXPORT std::string_view httpResponseHeader();
 
FAKER_CXX_EXPORT std::string_view httpMediaType();
 
FAKER_CXX_EXPORT std::string ipv4(const IPv4Class& ipv4class = IPv4Class::C);
 
FAKER_CXX_EXPORT std::string ipv4(const std::array<unsigned int, 4>& baseIpv4Address,
                                  const std::array<unsigned int, 4>& generationMask);
 
FAKER_CXX_EXPORT std::string ipv6();
 
FAKER_CXX_EXPORT std::string mac(const std::string& sep = ":");
 
FAKER_CXX_EXPORT unsigned port();
 
FAKER_CXX_EXPORT std::string url(const WebProtocol& webProtocol = WebProtocol::Https);
 
FAKER_CXX_EXPORT std::string domainName();
 
FAKER_CXX_EXPORT std::string domainWord();
 
FAKER_CXX_EXPORT std::string_view domainSuffix();
 
FAKER_CXX_EXPORT std::string anonymousUsername(unsigned maxLength);
}