gleam/string_builder
Types
Deprecated: The `string_builder` module has been deprecated, use the `string_tree.StringTree` type instead.
StringBuilder is a type used for efficiently building text content to be
written to a file or a socket. Internally it is represented as tree so to
append or prepend to a string builder is a constant time operation that
allocates a new node in the tree without copying any of the content. When
writing to an output stream the tree is traversed and the content is sent
directly rather than copying it into a single buffer beforehand.
On Erlang this type is compatible with Erlang’s iodata. On JavaScript this type is compatible with normal strings.
The BEAM virtual machine has an optimisation for appending strings, where it will mutate the string buffer when safe to do so, so if you are looking to build a string through appending many small strings then you may get better performance by not using a string builder. Always benchmark your performance sensitive code.
@deprecated("The `string_builder` module has been deprecated, use the `string_tree.StringTree` type instead.")
pub type StringBuilderFunctions
pub fn append(
to builder: StringBuilder,
suffix second: String,
) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.append` instead.
Appends a String onto the end of some StringBuilder.
Runs in constant time.
pub fn append_builder(
to builder: StringBuilder,
suffix suffix: StringBuilder,
) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.append_tree` instead.
Appends some StringBuilder onto the end of another.
Runs in constant time.
pub fn byte_size(builder: StringBuilder) -> IntDeprecated: The `string_builder` module has been deprecated, use `string_tree.byte_size` instead.
Returns the size of the StringBuilder in bytes.
pub fn concat(builders: List(StringBuilder)) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.concat` instead.
Joins a list of builders into a single builder.
Runs in constant time.
pub fn from_string(string: String) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.from_string` instead.
Converts a string into a builder.
Runs in constant time.
pub fn from_strings(strings: List(String)) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.from_strings` instead.
Converts a list of strings into a builder.
Runs in constant time.
pub fn is_empty(builder: StringBuilder) -> BoolDeprecated: The `string_builder` module has been deprecated, use `string_tree.is_empty` instead.
Inspects a builder to determine if it is equivalent to an empty string.
Examples
from_string("ok") |> is_empty
// -> False
from_string("") |> is_empty
// -> True
from_strings([]) |> is_empty
// -> True
pub fn is_equal(a: StringBuilder, b: StringBuilder) -> BoolDeprecated: The `string_builder` module has been deprecated, use `string_tree.is_equal` instead.
Compares two builders to determine if they have the same textual content.
Comparing two iodata using the == operator may return False even if they
have the same content as they may have been build in different ways, so
using this function is often preferred.
Examples
from_strings(["a", "b"]) == from_string("ab")
// -> False
is_equal(from_strings(["a", "b"]), from_string("ab"))
// -> True
pub fn join(
builders: List(StringBuilder),
with sep: String,
) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.join` instead.
Joins the given builders into a new builder separated with the given string
pub fn lowercase(builder: StringBuilder) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.lowercase` instead.
Converts a builder to a new builder where the contents have been lowercased.
pub fn new() -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.new` instead.
Create an empty StringBuilder. Useful as the start of a pipe chaining many
builders together.
pub fn prepend(
to builder: StringBuilder,
prefix prefix: String,
) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.prepend` instead.
Prepends a String onto the start of some StringBuilder.
Runs in constant time.
pub fn prepend_builder(
to builder: StringBuilder,
prefix prefix: StringBuilder,
) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.prepend_tree` instead.
Prepends some StringBuilder onto the start of another.
Runs in constant time.
pub fn replace(
in builder: StringBuilder,
each pattern: String,
with substitute: String,
) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.replace` instead.
Replaces all instances of a pattern with a given string substitute.
pub fn reverse(builder: StringBuilder) -> StringBuilderDeprecated: The `string_builder` module has been deprecated, use `string_tree.reverse` instead.
Converts a builder to a new builder with the contents reversed.
pub fn split(
iodata: StringBuilder,
on pattern: String,
) -> List(StringBuilder)Deprecated: The `string_builder` module has been deprecated, use `string_tree.split` instead.
Splits a builder on a given pattern into a list of builders.
pub fn to_string(builder: StringBuilder) -> StringDeprecated: The `string_builder` module has been deprecated, use `string_tree.to_string` instead.
Turns an StringBuilder into a String
This function is implemented natively by the virtual machine and is highly optimised.