PLCnext API Documentation 25.0.2.69
Public Member Functions | List of all members
Arp::Base::Rsc::Commons::RscSecureString< N > Class Template Reference

Specialized implementation of RscString for secure context. More...

#include <RscSecureString.hxx>

Inheritance diagram for Arp::Base::Rsc::Commons::RscSecureString< N >:
Inheritance graph

Public Member Functions

 RscSecureString (void)
 Constructs an empty RscSecureString.
 
 ~RscSecureString (void)
 Clears the string buffer.
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscString< N >
 RscString (void)
 Constructs an empty RscString.
 
 RscString (const char *pChars)
 Constructs an RscString instance and copies the null terminated c-string in internal buffer. More...
 
 RscString (const char8u *pChars)
 Constructs an RscString instance and copies the null terminated c-string in internal buffer. More...
 
 RscString (const String &arg)
 Constructor for type String. More...
 
 RscString (const RscString &arg)
 Default copy constructor. More...
 
 RscString (RscString &&arg) noexcept
 Default move constructor. More...
 
RscStringoperator= (const RscString &arg)
 Default copy-assignment operator. More...
 
RscStringoperator= (RscString &&arg) noexcept
 Default move-assignment operator. More...
 
 ~RscString (void)
 Default destructor.
 
RscStringoperator= (const char *pChars)
 Assigns the char buffer to this instance. More...
 
RscStringoperator= (const char8u *pChars)
 Assigns the UTF8 char buffer to this instance. More...
 
RscStringoperator= (const String &str)
 Assigns the String to this instance. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscStringBase
 operator String (void) const
 Converts this object implicit to an instance of type String. More...
 
size_t GetLength (void) const
 Gets the length of this string. More...
 
const char * CStr (void) const
 Returns a const char pointer to the internal string buffer. More...
 
String ToString (void) const
 Converts this object to an instance of type String. More...
 
void Clear (void)
 Clears this instance resulting in an empty string.
 
void Assign (const char *pChars)
 Assigns the char buffer to this instance. More...
 
void Assign (const String &str)
 Assigns the String to this instance. More...
 
void Read (RscReader &reader)
 Reads this string from RSC. More...
 
void Write (RscWriter &writer) const
 Writes this string to RSC. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Arp::Base::Rsc::Commons::RscString< N >
static constexpr size_t GetMaxLength (void)
 Get the maximal string length of this instance excluding string terminator. More...
 
- Protected Member Functions inherited from Arp::Base::Rsc::Commons::RscString< N >
 RscString (RscType stringType)
 Constructor for type < see cref="RscSecureString"/>. More...
 
- Protected Member Functions inherited from Arp::Base::Rsc::Commons::RscStringBase
 RscStringBase (RscType stringType)
 Constructs an empty RscStringBase instance. More...
 
 RscStringBase (const RscStringBase &arg)
 Default copy constructor. More...
 
 RscStringBase (RscStringBase &&arg) noexcept
 Default move constructor. More...
 
RscStringBaseoperator= (const RscStringBase &arg)=delete
 
RscStringBaseoperator= (RscStringBase &&arg) noexcept=delete
 
 ~RscStringBase (void)
 Default destructor.
 
void SetBufferInfo (char *pStringBuffer, size_t bufferSize, size_t strLength=0)
 Constructs an empty RscStringBase instance. More...
 
void SetBufferInfo (char *pStringBuffer, size_t bufferSize, const char *pChars)
 Constructs a RscStringBase instance. More...
 
void SetBufferInfo (char *pStringBuffer, size_t bufferSize, const String &str)
 Constructs a RscStringBase instance. More...
 
void Assign (const char *pChars, size_t count)
 Copies the char buffer to this instance with a given length. More...
 
void SetStringType (RscType value)
 Sets the string type of this instance. More...
 
RscType GetStringType (void) const
 Gets the string type of this instance. More...
 

Detailed Description

template<int N>
class Arp::Base::Rsc::Commons::RscSecureString< N >

Specialized implementation of RscString for secure context.


The documentation for this class was generated from the following file: