string.byte_size

Author: lpil

src/gleam/string.gleam

@@ -1025,3 +1025,22 @@ if erlang {
   external fn do_inspect(term: anything) -> StringBuilder =
     "gleam_stdlib" "inspect"
 }
+
+/// Returns the number of bytes in a `String`.
+/// 
+/// This function runs in constant time on Erlang and in linear time on
+/// JavaScript.
+///
+pub fn byte_size(string: String) -> Int {
+  do_byte_size(string)
+}
+
+if javascript {
+  external fn do_byte_size(String) -> Int =
+    "../gleam_stdlib.mjs" "byte_size"
+}
+
+if erlang {
+  external fn do_byte_size(String) -> Int =
+    "erlang" "byte_size"
+}

src/gleam_stdlib.erl

@@ -439,4 +439,3 @@ inspect_maybe_utf8_string(Binary, Acc) ->
 
 float_to_string(Float) when is_float(Float) ->
     erlang:iolist_to_binary(io_lib_format:fwrite_g(Float)).
-

src/gleam_stdlib.mjs

@@ -733,3 +733,7 @@ function try_get_field(value, field, or_else) {
     return or_else();
   }
 }
+
+export function byte_size(string) {
+  return new TextEncoder().encode(string).length;
+}

test/gleam/string_test.gleam

@@ -985,3 +985,17 @@ if erlang {
   ) -> List(anything) =
     "gleam_stdlib_test_ffi" "improper_list_append"
 }
+
+pub fn byte_size_test() {
+  let assert 0 = string.byte_size("")
+  let assert 1 = string.byte_size("a")
+  let assert 2 = string.byte_size("ab")
+  let assert 3 = string.byte_size("abc")
+
+  // Unicode graphemes. These will be multiple bytes.
+  let assert 1 = string.byte_size("a")
+  let assert 2 = string.byte_size("ä")
+  let assert 4 = string.byte_size("👩")
+  let assert 8 = string.byte_size("👩🏾")
+  let assert 15 = string.byte_size("👩🏾‍🦰")
+}