Martchus
/
cpp-utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Deprecate BinaryReader::readTerminatedString() methods

This commit is contained in:
Martchus 2018-01-29 16:30:46 +01:00
parent 209a59106e
commit b375ea80b0
2 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
io/binaryreader.cpp
View File

@ -134,6 +134,9 @@ string BinaryReader::readString(size_t length)
* Advances the current position of the stream by the string length plus one byte. * Advances the current position of the stream by the string length plus one byte.
* *
* \param termination The byte to be recognized as termination value. * \param termination The byte to be recognized as termination value.
*
* \deprecated This method is likely refactored/removed in v5.
* \todo Refactor/remove in v5.
*/ */
string BinaryReader::readTerminatedString(byte termination) string BinaryReader::readTerminatedString(byte termination)
{ {
@ -152,6 +155,9 @@ string BinaryReader::readTerminatedString(byte termination)
* *
* \param maxBytesToRead The maximal number of bytes to read. * \param maxBytesToRead The maximal number of bytes to read.
* \param termination The value to be recognized as termination. * \param termination The value to be recognized as termination.
*
* \deprecated This method is likely refactored/removed in v5.
* \todo Refactor/remove in v5.
*/ */
string BinaryReader::readTerminatedString(size_t maxBytesToRead, byte termination) string BinaryReader::readTerminatedString(size_t maxBytesToRead, byte termination)
{ {
@ -171,6 +177,9 @@ string BinaryReader::readTerminatedString(size_t maxBytesToRead, byte terminatio
* Advances the current position of the stream by the string length plus two bytes. * Advances the current position of the stream by the string length plus two bytes.
* *
* \param termination Specifies the two byte sized big endian value to be recognized as termination. * \param termination Specifies the two byte sized big endian value to be recognized as termination.
*
* \deprecated This method is likely refactored/removed in v5.
* \todo Refactor/remove in v5.
*/ */
string BinaryReader::readMultibyteTerminatedStringBE(uint16 termination) string BinaryReader::readMultibyteTerminatedStringBE(uint16 termination)
{ {
@ -195,6 +204,9 @@ string BinaryReader::readMultibyteTerminatedStringBE(uint16 termination)
* Advances the current position of the stream by the string length plus two bytes. * Advances the current position of the stream by the string length plus two bytes.
* *
* \param termination Specifies the two byte sized little endian value to be recognized as termination. * \param termination Specifies the two byte sized little endian value to be recognized as termination.
*
* \deprecated This method is likely refactored/removed in v5.
* \todo Refactor/remove in v5.
*/ */
string BinaryReader::readMultibyteTerminatedStringLE(uint16 termination) string BinaryReader::readMultibyteTerminatedStringLE(uint16 termination)
{ {
@ -221,6 +233,9 @@ string BinaryReader::readMultibyteTerminatedStringLE(uint16 termination)
* *
* \param maxBytesToRead The maximal number of bytes to read. * \param maxBytesToRead The maximal number of bytes to read.
* \param termination The two byte sized big endian value to be recognized as termination. * \param termination The two byte sized big endian value to be recognized as termination.
*
* \deprecated This method is likely refactored/removed in v5.
* \todo Refactor/remove in v5.
*/ */
string BinaryReader::readMultibyteTerminatedStringBE(std::size_t maxBytesToRead, uint16 termination) string BinaryReader::readMultibyteTerminatedStringBE(std::size_t maxBytesToRead, uint16 termination)
{ {
@ -245,6 +260,9 @@ string BinaryReader::readMultibyteTerminatedStringBE(std::size_t maxBytesToRead,
* *
* \param maxBytesToRead The maximal number of bytes to read. * \param maxBytesToRead The maximal number of bytes to read.
* \param termination The two byte sized little endian value to be recognized as termination. * \param termination The two byte sized little endian value to be recognized as termination.
*
* \deprecated This method is likely refactored/removed in v5.
* \todo Refactor/remove in v5.
*/ */
string BinaryReader::readMultibyteTerminatedStringLE(std::size_t maxBytesToRead, uint16 termination) string BinaryReader::readMultibyteTerminatedStringLE(std::size_t maxBytesToRead, uint16 termination)
{ {

1
io/binaryreader.h
View File

@ -62,7 +62,6 @@ public:
bool readBool(); bool readBool();
std::string readLengthPrefixedString(); std::string readLengthPrefixedString();
std::string readString(std::size_t length); std::string readString(std::size_t length);
// TODO: refactor methods for reading terminated strings in v5
std::string readTerminatedString(byte termination = 0); std::string readTerminatedString(byte termination = 0);
std::string readTerminatedString(size_t maxBytesToRead, byte termination = 0); std::string readTerminatedString(size_t maxBytesToRead, byte termination = 0);
std::string readMultibyteTerminatedStringBE(uint16 termination = 0); std::string readMultibyteTerminatedStringBE(uint16 termination = 0);