SafeString.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/Exception.hpp"
#include <cstddef>
#include <span>
 
namespace Arp::Base::Core
{
 
class ARP_EXPORT SafeString
{
public: // construction
    SafeString(void) = delete; // makes this class pure static
 
public: // static operations
    static size_t   GetBufferSizeLimit(void);
    static size_t   GetStringLengthLimit(void);
    static bool     IsNullOrEmpty(const char* str);
    static size_t   GetLength(std::span<const char> str);
    static size_t   GetLength(const char* str, size_t bufferSize);
    static bool     TryGetLength(std::span<const char> str, size_t& result);
    static bool     TryGetLength(const char* str, size_t bufferSize, size_t& result);
    static void     Copy(std::span<char> destStr, const char* srcStr);
    static void     Copy(std::span<char> destStr, const char* srcStr, size_t count);
    static void     Copy(char* destStr, size_t bufferSize, const char* srcStr);
    static void     Copy(char* destStr, size_t bufferSize, const char* srcStr, size_t count);
 
private: // methods
    static Exception    CreateException(const char* reason);
};
 
} // end of namespace Arp::Base::Core
 
namespace Arp {
using Arp::Base::Core::SafeString;
}