OnixS C++ FIX Engine  4.12.0
API Documentation
SecureStringBuilder Class Reference

#include <OnixS/FIXEngine/Cryptography/SecureString.h>

Public Member Functions

 SecureStringBuilder ()
 
 SecureStringBuilder (FIX::StringRef plainText)
 
 SecureStringBuilder (const char *plainText, size_t plainTextLength)
 
 SecureStringBuilder (const SecureStringBuilder &other)
 
SecureStringBuilderoperator= (const SecureStringBuilder &other)
 
 ~SecureStringBuilder ()
 
size_t length () const
 
SecureString detach ()
 
void assign (FIX::StringRef plainText)
 
void assign (const char *plainText, size_t plainTextLength)
 
void append (char c)
 
void insert (size_t index, char c)
 
void replace (size_t index, char c)
 
void erase (size_t index)
 
void clear ()
 

Detailed Description

Definition at line 70 of file SecureString.h.

Constructor & Destructor Documentation

SecureStringBuilder ( )
explicit

Constructs the empty SecureStringBuilder.

SecureStringBuilder ( FIX::StringRef  plainText)
explicit

Constructs the SecureStringBuilder which stores the encrypted plainText as an initial value.

Parameters
plainTextThe plain text to be encrypted and stored.
SecureStringBuilder ( const char *  plainText,
size_t  plainTextLength 
)

Constructs the SecureStringBuilder which stores the encrypted plainText as an initial value.

Parameters
plainTextThe plain text to be encrypted and stored.
plainTextLengthThe plain text length.

Initializes the instance as a deep copy of other one.

Member Function Documentation

void append ( char  c)

Appends a character to the end of the current secure string.

void assign ( FIX::StringRef  plainText)

Replaces the secure value with a new one.

Parameters
plainTextplain text to be encrypted and stored.
void assign ( const char *  plainText,
size_t  plainTextLength 
)

Replaces internal value with a new one.

Parameters
plainTextThe plain text to be encrypted and stored.
plainTextLengthThe plain text length.
void clear ( )

Deletes the value of the current secure string.

SecureString detach ( )

Moves the encoded data to the immutable SecureString object.

SecureStringBuilder becomes empty after detaching.

void erase ( size_t  index)

Removes the character at the specified index position from this secure string.

void insert ( size_t  index,
char  c 
)

Inserts a character in this secure string at the specified index position.

size_t length ( ) const

Gets the number of characters in the current secure string.

SecureStringBuilder& operator= ( const SecureStringBuilder other)

Makes a deep copy of another SecureStringBuilder.

void replace ( size_t  index,
char  c 
)

Replaces the existing character at the specified index position with another character.


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