string.h

Go to the documentation of this file.

#pragma once
 
#include <algorithm>
#include <array>
#include <chrono>
#include <cstdint>
#include <cstring>
#include <ctime>
#include <iomanip>
#include <limits>
#include <map>
#include <optional>
#include <random>
#include <set>
#include <sstream>
#include <string>
#include <string_view>
 
#include "faker-cxx/export.h"
#include "random_generator.h"
 
namespace faker::string
{
enum class Uuid
{
    V1, // Version 1: UUIDs using a timestamp and monotonic counter.
    V3, // Version 3: UUIDs based on the MD5 hash of some data.
    V4, // Version 4: UUIDs with random data.
    V5, // Version 5: UUIDs based on the SHA1 hash of some data.
    V6, // Version 6: UUIDs using a timestamp and monotonic counter (sortable).
    V7, // Version 7: UUIDs using a Unix timestamp (sortable).
    V8  // Version 8: UUIDs using user-defined data.
};
 
enum class StringCasing
{
    Mixed,
    Lower,
    Upper
};
 
struct FAKER_CXX_EXPORT CharCount
{
    unsigned int atLeastCount{(std::numeric_limits<unsigned>::min)()};
    unsigned int atMostCount{(std::numeric_limits<unsigned>::max)()};
};
 
using GuaranteeMap = std::map<char, CharCount>;
 
FAKER_CXX_EXPORT bool isValidGuarantee(GuaranteeMap& guarantee, std::set<char>& targetCharacters, unsigned length);
 
FAKER_CXX_EXPORT std::string generateAtLeastString(const GuaranteeMap& guarantee);
 
FAKER_CXX_EXPORT std::string uuid(Uuid uuid = Uuid::V4);
 
FAKER_CXX_EXPORT std::string ulid(time_t refDate = std::time(nullptr));
 
FAKER_CXX_EXPORT std::string sample(unsigned length = 10);
 
FAKER_CXX_EXPORT std::string sample(GuaranteeMap&& guarantee, unsigned length = 10);
 
FAKER_CXX_EXPORT std::string symbol(unsigned minLength = 1, unsigned maxLength = 10);
 
FAKER_CXX_EXPORT std::string fromCharacters(const std::string& characters, unsigned length = 1);
 
FAKER_CXX_EXPORT std::string fromCharacters(GuaranteeMap&& guarantee, const std::string& characters,
                                            unsigned length = 1);
 
FAKER_CXX_EXPORT std::string alpha(unsigned length = 1, StringCasing casing = StringCasing::Mixed,
                                   const std::string& excludeCharacters = "");
 
FAKER_CXX_EXPORT std::string alpha(GuaranteeMap&& guarantee, unsigned length = 1,
                                   StringCasing casing = StringCasing::Mixed);
 
FAKER_CXX_EXPORT std::string alphanumeric(unsigned length = 1, StringCasing casing = StringCasing::Mixed,
                                          const std::string& excludeCharacters = "");
 
FAKER_CXX_EXPORT std::string alphanumeric(GuaranteeMap&& guarantee, unsigned length = 1,
                                          StringCasing casing = StringCasing::Mixed);
 
FAKER_CXX_EXPORT std::string numeric(unsigned length = 1, bool allowLeadingZeros = true);
 
FAKER_CXX_EXPORT std::string numeric(GuaranteeMap&& guarantee, unsigned length = 1, bool allowLeadingZeros = true);
 
FAKER_CXX_EXPORT std::string nanoId(int length);
 
FAKER_CXX_EXPORT std::string nanoId();
 
FAKER_CXX_EXPORT std::string nanoId(int minLength, int maxLength);
}