gossamer - v8.0.0

gossamer/string

Extensions to gleam/string for JS-specific operations — Unicode normalization, locale-aware comparison and case conversion, code point manipulation, and the JS string methods not covered by Gleam’s standard library.

Values

at

</> 
pub fn at(
  string: String,
  index index: Int,
) -> Result(String, Nil)

Returns the UTF-16 code unit at index as a single-character string, or Error(Nil) if the index is out of range. Negative indices count from the end.

char_code_at

</> 
pub fn char_code_at(
  string: String,
  index index: Int,
) -> Result(Int, Nil)

Returns the UTF-16 code unit at index, or Error(Nil) if the index is out of range.

code_point_at

</> 
pub fn code_point_at(
  string: String,
  index index: Int,
) -> Result(Int, Nil)

Returns the Unicode code point at index, or Error(Nil) if the index is out of range.

concat

</> 
pub fn concat(string: String, and other: String) -> String

ends_with

</> 
pub fn ends_with(string: String, suffix suffix: String) -> Bool

ends_with_within

</> 
pub fn ends_with_within(
  string: String,
  suffix suffix: String,
  within length: Int,
) -> Bool

from_char_code

</> 
pub fn from_char_code(code: Int) -> String

from_char_codes

</> 
pub fn from_char_codes(codes: List(Int)) -> String

from_code_point

</> 
pub fn from_code_point(
  code: Int,
) -> Result(String, js_error.JsError)

Returns an error if the code point is invalid.

from_code_points

</> 
pub fn from_code_points(
  codes: List(Int),
) -> Result(String, js_error.JsError)

Returns an error if any code point is invalid.

includes

</> 
pub fn includes(in string: String, search search: String) -> Bool

includes_from

</> 
pub fn includes_from(
  in string: String,
  search search: String,
  from position: Int,
) -> Bool

index_of

</> 
pub fn index_of(
  in string: String,
  search search: String,
) -> Result(Int, Nil)

Returns the first index of search in the string, or Error(Nil) if not found.

index_of_from

</> 
pub fn index_of_from(
  in string: String,
  search search: String,
  from position: Int,
) -> Result(Int, Nil)

Like index_of, but starts searching from position.

is_well_formed

</> 
pub fn is_well_formed(string: String) -> Bool

last_index_of

</> 
pub fn last_index_of(
  in string: String,
  search search: String,
) -> Result(Int, Nil)

Returns the last index of search in the string, or Error(Nil) if not found.

last_index_of_from

</> 
pub fn last_index_of_from(
  in string: String,
  search search: String,
  from position: Int,
) -> Result(Int, Nil)

Like last_index_of, but searches backwards from position.

length

</> 
pub fn length(of string: String) -> Int

Returns the number of UTF-16 code units. This differs from gleam/string.length which counts grapheme clusters.

locale_compare

</> 
pub fn locale_compare(
  string: String,
  to other: String,
) -> order.Order

normalize

</> 
pub fn normalize(string: String) -> String

Returns the NFC-normalized form of the string.

normalize_with

</> 
pub fn normalize_with(
  string: String,
  form form: normalization_form.NormalizationForm,
) -> String

pad_end

</> 
pub fn pad_end(
  string: String,
  to target_length: Int,
  with pad: String,
) -> Result(String, js_error.JsError)

Pads the end to reach target_length UTF-16 code units. This differs from gleam/string.pad_end which counts grapheme clusters. Returns an error if the padded string would exceed the maximum string length.

pad_start

</> 
pub fn pad_start(
  string: String,
  to target_length: Int,
  with pad: String,
) -> Result(String, js_error.JsError)

Pads the start to reach target_length UTF-16 code units. This differs from gleam/string.pad_start which counts grapheme clusters. Returns an error if the padded string would exceed the maximum string length.

repeat

</> 
pub fn repeat(
  string: String,
  times times: Int,
) -> Result(String, js_error.JsError)

Returns the string repeated times times. Returns an error if times is negative or the resulting string would exceed the maximum string length.

replace

</> 
pub fn replace(
  in string: String,
  pattern pattern: String,
  with replacement: String,
) -> String

Replaces the first occurrence only. Use replace_all to replace every occurrence.

replace_all

</> 
pub fn replace_all(
  in string: String,
  pattern pattern: String,
  with replacement: String,
) -> String

slice

</> 
pub fn slice(
  string: String,
  from start: Int,
  to end: Int,
) -> String

Extracts a section of the string between start and end. Indices are UTF-16 code units — this differs from gleam/string.slice which counts grapheme clusters.

split

</> 
pub fn split(
  string: String,
  on separator: String,
) -> List(String)

split_with_limit

</> 
pub fn split_with_limit(
  string: String,
  on separator: String,
  limit limit: Int,
) -> List(String)

starts_with

</> 
pub fn starts_with(string: String, prefix prefix: String) -> Bool

starts_with_from

</> 
pub fn starts_with_from(
  string: String,
  prefix prefix: String,
  from position: Int,
) -> Bool

substring

</> 
pub fn substring(
  string: String,
  from start: Int,
  to end: Int,
) -> String

Like slice, but swaps start and end if start is greater, and treats negative values as zero. Indices are UTF-16 code units — this differs from gleam/string.slice which counts grapheme clusters.

to_locale_lower_case

</> 
pub fn to_locale_lower_case(string: String) -> String

to_locale_upper_case

</> 
pub fn to_locale_upper_case(string: String) -> String

to_lower_case

</> 
pub fn to_lower_case(string: String) -> String

to_upper_case

</> 
pub fn to_upper_case(string: String) -> String

to_well_formed

</> 
pub fn to_well_formed(string: String) -> String

trim

</> 
pub fn trim(string: String) -> String

trim_end

</> 
pub fn trim_end(string: String) -> String

trim_start

</> 
pub fn trim_start(string: String) -> String
✨ Search Document