CkStringBuilder Ruby Reference Documentation
CkStringBuilder
Current Version: 10.1.0
A simple class for building strings. (Represents a mutable string of characters.)
Note: This class was introduced in Chilkat v9.5.0.58.
Object Creation
obj = Chilkat::CkStringBuilder.new()
Properties
IntValue
intVal = stringBuilder.get_IntValue();
stringBuilder.put_IntValue(intVal);
Returns the content of the string converted to an integer.
topIsBase64
boolVal = stringBuilder.get_IsBase64();
Returns true if the content contains only those characters allowed in the base64 encoding. A base64 string is composed of characters 'A'..'Z', 'a'..'z', '0'..'9', '+', '/' and it is often padded at the end with up to two '=', to make the length a multiple of 4. Whitespace is ignored.
topLastMethodSuccess
boolVal = stringBuilder.get_LastMethodSuccess();
stringBuilder.put_LastMethodSuccess(boolVal);
Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = true and failure = false.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topLength
intVal = stringBuilder.get_Length();
The number of characters of the string contained within this instance.
topUtf8
boolVal = stringBuilder.get_Utf8();
stringBuilder.put_Utf8(boolVal);
When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.
topMethods
Append
status = stringBuilder.Append(value);
Appends a copy of the specified string to this instance.
Returns true for success, false for failure.
topAppendBd
# charset is a string
# offset is an integer
# numBytes is an integer
status = stringBuilder.AppendBd(binData, charset, offset, numBytes);
Appends the contents of binData. The charset specifies the character encoding of the bytes contained in binData. The charset can be any of the supported encodings listed at Chilkat Supported Character Encodings. To append the entire contents of binData, set offset and numBytes equal to zero. To append a range of binData, set the offset and numBytes to specify the range.
Returns true for success, false for failure.
topAppendEncoded
# encoding is a string
status = stringBuilder.AppendEncoded(binaryData, encoding);
Appends binary data using the encoding specified by encoding, such as "base64", "hex", etc.
Returns true for success, false for failure.
AppendInt
status = stringBuilder.AppendInt(value);
Appends the string representation of a specified 32-bit signed integer to this instance.
Returns true for success, false for failure.
topAppendInt64
status = stringBuilder.AppendInt64(value);
Appends the string representation of a specified 64-bit signed integer to this instance.
Returns true for success, false for failure.
topAppendLine
# crlf is a boolean
status = stringBuilder.AppendLine(value, crlf);
Appends the value followed by a CRLF or LF to the end of the curent StringBuilder object. If crlf is true, then a CRLF line ending is used. Otherwise a LF line ending is used.
Returns true for success, false for failure.
topAppendRandom
# encoding is a string
status = stringBuilder.AppendRandom(numBytes, encoding);
Append numBytes random bytes encoded according to encoding. encoding can be "hex", "hex_lower", "base64", "base64url", or any other encoding supported by Chilkat.
Returns true for success, false for failure.
topAppendSb
status = stringBuilder.AppendSb(sb);
Appends the contents of another StringBuilder to this instance.
Returns true for success, false for failure.
topAppendUuid
status = stringBuilder.AppendUuid(lowerCase);
Generates and appends a random GUID/UUID such as 63c35f38-2b5f-4600-b3da-3ddee86d62b3. If lowerCase is true, then the hex values use lowercase ("a" - "f"). If lowerCase is false then uppercase is used ("A" - "F").
Note: This generates a version 4 UUID.
Returns true for success, false for failure.
AppendUuid7
status = stringBuilder.AppendUuid7(lowerCase);
Generates and appends a random version 7 UUID. If lowerCase is true, then the hex values use lowercase ("a" - "f"). If lowerCase is false then uppercase is used ("A" - "F").
Returns true for success, false for failure.
topClear
Removes all characters from the current StringBuilder instance.
topContains
# caseSensitive is a boolean
retBool = stringBuilder.Contains(str, caseSensitive);
Returns true if the str is contained within this object. For case sensitive matching, set caseSensitive equal to true. For case-insensitive, set caseSensitive equal to false.
topContainsWord
# caseSensitive is a boolean
retBool = stringBuilder.ContainsWord(word, caseSensitive);
Returns true if the word is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)
For case sensitive matching, set caseSensitive equal to true. For case-insensitive, set caseSensitive equal to false.
topContentsEqual
# caseSensitive is a boolean
retBool = stringBuilder.ContentsEqual(str, caseSensitive);
Returns true if the contents of this object equals the str. Returns false if unequal. For case insensitive equality, set caseSensitive equal to false.
topContentsEqualSb
# caseSensitive is a boolean
retBool = stringBuilder.ContentsEqualSb(sb, caseSensitive);
Returns true if the contents of this object equals the sb. Returns false if unequal. For case insensitive equality, set caseSensitive equal to false.
topDecode
# charset is a string
status = stringBuilder.Decode(encoding, charset);
Decodes and replaces the contents with the decoded string. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.
Note: This method can only be called if the encoded content decodes to a string. The charset indicates the charset to be used in intepreting the decoded bytes. For example, the charset can be "utf-8", "utf-16", "iso-8859-1", "shift_JIS", etc.
Returns true for success, false for failure.
DecodeAndAppend
# encoding is a string
# charset is a string
status = stringBuilder.DecodeAndAppend(value, encoding, charset);
Decodes a binary encoded string, where the binary encoding (such as "url", "hex", "base64", etc.) is specified by encoding, and the underlying charset encoding (such as "utf-8", "windows-1252", etc.) is specified by charset. The decoded string is appended to this object.
Returns true for success, false for failure.
Encode
# charset is a string
status = stringBuilder.Encode(encoding, charset);
Encodes to base64, hex, quoted-printable, URL encoding, etc. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.
Returns true for success, false for failure.
EndsWith
# caseSensitive is a boolean
retBool = stringBuilder.EndsWith(substr, caseSensitive);
Returns true if the string ends with substr. Otherwise returns false. The comparison is case sensitive if caseSensitive is true, and case insensitive if caseSensitive is false.
topEntityDecode
Decodes HTML entities. See HTML entities for more information about HTML entities.
Returns true for success, false for failure.
GetAfterBetween
# beginMark is a string
# endMark is a string
# outStr is a CkString (output)
status = stringBuilder.GetAfterBetween(searchAfter, beginMark, endMark, outStr);
retStr = stringBuilder.getAfterBetween(searchAfter, beginMark, endMark);
Begin searching after the 1st occurrence of searchAfter is found, and then return the substring found between the next occurrence of beginMark and the next occurrence of endMark.
Returns true for success, false for failure.
GetAfterFinal
# removeFlag is a boolean
# outStr is a CkString (output)
status = stringBuilder.GetAfterFinal(marker, removeFlag, outStr);
retStr = stringBuilder.getAfterFinal(marker, removeFlag);
Returns the substring found after the final occurrence of marker. If removeFlag is true, the marker and the content that follows is removed from this content.
If the marker is not present, then the entire string is returned. In this case, if removeFlag is true, this object is also cleared.
Returns true for success, false for failure.
GetAsString
status = stringBuilder.GetAsString(outStr);
retStr = stringBuilder.getAsString();
GetBefore
# removeFlag is a boolean
# outStr is a CkString (output)
status = stringBuilder.GetBefore(marker, removeFlag, outStr);
retStr = stringBuilder.getBefore(marker, removeFlag);
Returns the substring found before the 1st occurrence of marker. If removeFlag is true, the content up to and including the marker is removed from this object's contents.
If the marker is not present, then the entire string is returned. In this case, if removeFlag is true, this object is also cleared.
Returns true for success, false for failure.
GetBetween
# endMark is a string
# outStr is a CkString (output)
status = stringBuilder.GetBetween(beginMark, endMark, outStr);
retStr = stringBuilder.getBetween(beginMark, endMark);
Returns the substring found between the 1st occurrence of beginMark and the next occurrence of endMark.
Returns true for success, false for failure.
GetDecoded
# outBytes is a CkByteData (output)
status = stringBuilder.GetDecoded(encoding, outData);
Decodes and returns the decoded bytes. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.
Returns true for success, false for failure.
topGetEncoded
# charset is a string
# outStr is a CkString (output)
status = stringBuilder.GetEncoded(encoding, charset, outStr);
retStr = stringBuilder.getEncoded(encoding, charset);
Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.
Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.
Returns true for success, false for failure.
GetHash
# encoding is a string
# charset is a string
# outStr is a CkString (output)
status = stringBuilder.GetHash(algorithm, encoding, charset, outStr);
retStr = stringBuilder.getHash(algorithm, encoding, charset);
Returns the hash of the contents of this object. The algorithm is the hash algorithm, and can be "sha1", "sha256", "sha384", "sha512", "sha3-224", "sha3-256", "sha3-384", "sha3-512", "md2", "md5", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The encoding can be "base64", "modBase64", "base64Url", "base32", "base58", "qp" (for quoted-printable), "url" (for url-encoding), "hex", "hexLower", or any of the encodings found at Chilkat Binary Encodings List.
The charset is the character encoding byte representation to hash. It is typically "utf-8". It can be any of the chacter encodings listed at Chilkat Character Encodings List.
Returns true for success, false for failure.
GetNth
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
# outStr is a CkString (output)
status = stringBuilder.GetNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped, outStr);
retStr = stringBuilder.getNth(index, delimiterChar, exceptDoubleQuoted, exceptEscaped);
Returns the Nth substring in string that is a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is true, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is true, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Returns true for success, false for failure.
GetRange
# numChars is an integer
# removeFlag is a boolean
# outStr is a CkString (output)
status = stringBuilder.GetRange(startIndex, numChars, removeFlag, outStr);
retStr = stringBuilder.getRange(startIndex, numChars, removeFlag);
Returns a string containing the specified range of characters from this instance. If removeFlag is true, then the range of chars is removed from this instance.
Note: It was discovered that the range of chars was always removed regardless of the value of removeFlag. This is fixed in v9.5.0.89.
Returns true for success, false for failure.
LastNLines
# bCrlf is a boolean
# outStr is a CkString (output)
status = stringBuilder.LastNLines(numLines, bCrlf, outStr);
retStr = stringBuilder.lastNLines(numLines, bCrlf);
Returns the last N lines of the text. If fewer than numLines lines exists, then all of the text is returned. If bCrlf is true, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.
Returns true for success, false for failure.
LoadFile
# charset is a string
status = stringBuilder.LoadFile(path, charset);
Loads the contents of a file.
Returns true for success, false for failure.
Obfuscate
Obfuscates the string. (The Unobfuscate method can be called to reverse the obfuscation to restore the original string.)
The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is NOT a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.
Prepend
status = stringBuilder.Prepend(value);
Prepends a copy of the specified string to this instance.
Returns true for success, false for failure.
topPunyDecode
In-place decodes the string from punycode.
Returns true for success, false for failure.
PunyEncode
In-place encodes the string to punycode.
Returns true for success, false for failure.
RemoveAccents
Removes the accents (diacritics) from European accented characters. This applies only to the accented characters found in the Windows-1252 (Latin alphabet) and Windows-1250 (Central European) charsets. Accent marks for characters in other languages will not be removed.
Returns true for success, false for failure.
RemoveAfterFinal
status = stringBuilder.RemoveAfterFinal(marker);
Removes the substring found after the final occurrence of the marker. Also removes the marker. Returns true if the marker was found and content was removed. Otherwise returns false.
Returns true for success, false for failure.
RemoveBefore
status = stringBuilder.RemoveBefore(marker);
Removes the substring found before the 1st occurrence of the marker. Also removes the marker. Returns true if the marker was found and content was removed. Otherwise returns false.
Returns true for success, false for failure.
RemoveCharsAt
# numChars is an integer
status = stringBuilder.RemoveCharsAt(startIndex, numChars);
Removes the specified range of characters from this instance.
Returns true for success, false for failure.
Replace
# replacement is a string
retInt = stringBuilder.Replace(value, replacement);
Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.
topReplaceAfterFinal
# replacement is a string
status = stringBuilder.ReplaceAfterFinal(marker, replacement);
Replaces the content found after the final occurrence of marker with replacement.
Returns true for success, false for failure.
topReplaceAllBetween
# endMark is a string
# replacement is a string
# replaceMarks is a boolean
status = stringBuilder.ReplaceAllBetween(beginMark, endMark, replacement, replaceMarks);
Replaces the first occurrence of ALL the content found between beginMark and endMark with replacement. The beginMark and endMark are included in what is replaced if replaceMarks is true.
Returns true for success, false for failure.
ReplaceBetween
# endMark is a string
# value is a string
# replacement is a string
retInt = stringBuilder.ReplaceBetween(beginMark, endMark, value, replacement);
Replaces all occurrences of value with replacement, but only where value is found between beginMark and endMark. Returns the number of replacements made.
ReplaceFirst
# replacement is a string
status = stringBuilder.ReplaceFirst(value, replacement);
Replaces the first occurrence of a specified string in this instance with another string. Returns true if the value was found and replaced. Otherwise returns false.
Returns true for success, false for failure.
ReplaceI
# replacement is an integer
retInt = stringBuilder.ReplaceI(value, replacement);
Replaces all occurrences of value with the decimal integer replacement. Returns the number of replacements.
topReplaceNoCase
# replacement is a string
retInt = stringBuilder.ReplaceNoCase(value, replacement);
Replaces all occurrences of value with replacement (case insensitive). Returns the number of replacements.
topReplaceWord
# replacement is a string
retInt = stringBuilder.ReplaceWord(value, replacement);
Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.
Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)
SecureClear
Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.
topSetNth
# value is a string
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
status = stringBuilder.SetNth(index, value, delimiterChar, exceptDoubleQuoted, exceptEscaped);
Sets the Nth substring in string in a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is true, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is true, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Returns true for success, false for failure.
SetString
status = stringBuilder.SetString(value);
Sets this instance to a copy of the specified string.
Returns true for success, false for failure.
topShorten
status = stringBuilder.Shorten(numChars);
Shortens the string by removing the last numChars chars.
Returns true for success, false for failure.
StartsWith
# caseSensitive is a boolean
retBool = stringBuilder.StartsWith(substr, caseSensitive);
Returns true if the string starts with substr. Otherwise returns false. The comparison is case sensitive if caseSensitive is true, and case insensitive if caseSensitive is false.
topToCRLF
ToLF
ToLowercase
ToUppercase
Trim
TrimInsideSpaces
Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.
Returns true for success, false for failure.
topUnobfuscate
Unobfuscates the string.
The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.
WriteFile
# charset is a string
# emitBom is a boolean
status = stringBuilder.WriteFile(path, charset, emitBom);
Writes the contents to a file. If emitBom is true, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)
Returns true for success, false for failure.
topWriteFileIfModified
# charset is a string
# emitBom is a boolean
status = stringBuilder.WriteFileIfModified(path, charset, emitBom);
Writes the contents to a file, but only if it is a new file or if the contents are different than the existing file. If emitBom is true, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)
Returns true for success, false for failure.
top