The string class. More...

#include <WString.h>

Inheritance diagram for String:

Public Member Functions
STRING_IRAM_ATTR	String (const char *cstr=nullptr)

STRING_IRAM_ATTR	String (const char *cstr, unsigned int length)

STRING_IRAM_ATTR	String (const String &str)

	String (flash_string_t pstr, int length=-1)

	String (const FlashString &fstr)

STRING_IRAM_ATTR	String (String &&rval)

STRING_IRAM_ATTR	String (StringSumHelper &&rval)

	String (char c)

	String (unsigned char, unsigned char base=10)

	String (int, unsigned char base=10)

	String (unsigned int, unsigned char base=10)

	String (long, unsigned char base=10)

	String (unsigned long, unsigned char base=10)

	String (float, unsigned char decimalPlaces=2)

	String (double, unsigned char decimalPlaces=2)

void	setString (const char *cstr, int length=-1)

void	setString (flash_string_t pstr, int length=-1)

bool	reserve (unsigned int size)

bool	setLength (unsigned int length)
	set the string length accordingly, expanding if necessary More...

unsigned int	length (void) const

String &STRING_IRAM_ATTR	operator= (const String &rhs)

String &STRING_IRAM_ATTR	operator= (const char *cstr)

String &	operator= (String &&rval)

String &	operator= (StringSumHelper &&rval)

bool	concat (const String &str)

bool	concat (const char *cstr)

bool STRING_IRAM_ATTR	concat (const char *cstr, unsigned int length)

bool	concat (char c)

bool	concat (unsigned char c)

bool	concat (int num)

bool	concat (unsigned int num)

bool	concat (long num)

bool	concat (unsigned long num)

bool	concat (float num)

bool	concat (double num)

String &	operator+= (const String &rhs)

String &	operator+= (const char *cstr)

String &	operator+= (char c)

String &	operator+= (unsigned char num)

String &	operator+= (int num)

String &	operator+= (unsigned int num)

String &	operator+= (long num)

String &	operator+= (unsigned long num)

String &	operator+= (float num)

String &	operator+= (double num)

	operator StringIfHelperType () const

int STRING_IRAM_ATTR	compareTo (const String &s) const

bool STRING_IRAM_ATTR	equals (const String &s) const

bool STRING_IRAM_ATTR	equals (const char *cstr) const

bool	equals (const FlashString &fstr) const

bool STRING_IRAM_ATTR	operator== (const String &rhs) const

bool STRING_IRAM_ATTR	operator== (const char *cstr) const

bool STRING_IRAM_ATTR	operator== (const FlashString &fstr) const

bool STRING_IRAM_ATTR	operator!= (const String &rhs) const

bool STRING_IRAM_ATTR	operator!= (const char *cstr) const

bool	operator< (const String &rhs) const

bool	operator> (const String &rhs) const

bool	operator<= (const String &rhs) const

bool	operator>= (const String &rhs) const

bool	equalsIgnoreCase (const char *cstr) const

bool	equalsIgnoreCase (const String &s2) const

bool	equalsIgnoreCase (const FlashString &fstr) const

bool	startsWith (const String &prefix) const

bool	startsWith (const String &prefix, unsigned int offset) const

bool	endsWith (const String &suffix) const

char STRING_IRAM_ATTR	charAt (unsigned int index) const

void STRING_IRAM_ATTR	setCharAt (unsigned int index, char c)

char STRING_IRAM_ATTR	operator[] (unsigned int index) const

char &STRING_IRAM_ATTR	operator[] (unsigned int index)

unsigned int	getBytes (unsigned char *buf, unsigned int bufsize, unsigned int index=0) const
	read contents of string into a buffer More...

void	toCharArray (char *buf, unsigned int bufsize, unsigned int index=0) const

const char *	c_str () const

char *	begin ()

char *	end ()

const char *	begin () const

const char *	end () const

int STRING_IRAM_ATTR	indexOf (char ch) const

int	indexOf (char ch, unsigned int fromIndex) const

int STRING_IRAM_ATTR	indexOf (const String &str) const

int	indexOf (const String &s2, unsigned int fromIndex) const

int	lastIndexOf (char ch) const

int	lastIndexOf (char ch, unsigned int fromIndex) const

int	lastIndexOf (const String &s2) const

int	lastIndexOf (const String &s2, unsigned int fromIndex) const

String	substring (unsigned int beginIndex) const

String	substring (unsigned int beginIndex, unsigned int endIndex) const

void	replace (char find, char replace)

void	replace (const String &find, const String &replace)

void	remove (unsigned int index)

void	remove (unsigned int index, unsigned int count)

void	toLowerCase (void)

void	toUpperCase (void)

void	trim (void)

long	toInt (void) const

float	toFloat (void) const

Static Public Attributes
static const String	nullstr
	A null string evaluates to false. More...

static const String	empty
	An empty string evaluates to true. More...

Protected Member Functions
void STRING_IRAM_ATTR	invalidate (void)

bool STRING_IRAM_ATTR	changeBuffer (unsigned int maxStrLen)

String &	copy (const char *cstr, unsigned int length)

String &	copy (flash_string_t pstr, unsigned int length)

void	move (String &rhs)

Protected Attributes
char *	buffer = nullptr

uint16_t	capacity = 0

uint16_t	len = 0

Friends
StringSumHelper &	operator+ (const StringSumHelper &lhs, const String &rhs)

StringSumHelper &	operator+ (const StringSumHelper &lhs, const char *cstr)

StringSumHelper &	operator+ (const StringSumHelper &lhs, char c)

StringSumHelper &	operator+ (const StringSumHelper &lhs, unsigned char num)

StringSumHelper &	operator+ (const StringSumHelper &lhs, int num)

StringSumHelper &	operator+ (const StringSumHelper &lhs, unsigned int num)

StringSumHelper &	operator+ (const StringSumHelper &lhs, long num)

StringSumHelper &	operator+ (const StringSumHelper &lhs, unsigned long num)

StringSumHelper &	operator+ (const StringSumHelper &lhs, float num)

StringSumHelper &	operator+ (const StringSumHelper &lhs, double num)

Detailed Description

The string class.

Note that a string object's default constructor creates an empty string. This is not the same as a null string. A null string evaluates to false An empty string evaluates to true

Member Function Documentation

unsigned int String::getBytes	(	unsigned char *	buf,
		unsigned int	bufsize,
		unsigned int	index = `0`
	)		const

read contents of string into a buffer

Parameters

buf	buffer to write data
bufsize	size of buffer in bytes
index	offset to start

Return values

unsigned number of bytes copied, excluding nul terminator

Note: Returned data always nul terminated so buffer size needs to take this into account

bool String::setLength ( unsigned int length )

set the string length accordingly, expanding if necessary

Parameters

length required for string (nul terminator additional)

Return values

true	on success, false on failure

Note: extra characters are undefined

Member Data Documentation

const String String::empty

static

An empty string evaluates to true.

const String String::nullstr

static

A null string evaluates to false.

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation

Member Data Documentation