gleam_stdlib

0.42.0
1.0.3 1.0.2 1.0.1 1.0.0 0.71.0 0.70.0 0.69.0 0.68.1 0.68.0 0.67.1 0.67.0 0.65.0 0.64.0 0.63.2 0.63.1 0.63.0 0.62.1 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.1 0.35.0 0.34.0 0.33.1 0.33.0 0.32.1 0.32.0 0.31.0 0.30.2 0.30.1 0.30.0 0.29.2 0.29.1 0.29.0 0.28.2 0.28.1 0.28.0 0.27.0 0.26.1 0.26.0 0.25.0 0.24.0 0.23.0 0.22.3 0.22.2 0.22.1 0.22.0 0.21.0 0.20.0 0.19.3 0.19.2 0.19.1 0.19.0 0.18.1 0.18.0 0.18.0-rc1 0.17.1 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.1 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.4.0-rc1 0.3.1 0.3.0 0.2.0 retired
A standard library for the Gleam programming language
HexDocs
Current section
Files
Jump to
Readme 100 Versions 0 Dependencies 1565 Dependants Files Activity
gleam_stdlib src gleam@string.erl
Raw
src/gleam@string.erl

-module(gleam@string).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch]).

-export([is_empty/1, length/1, reverse/1, replace/3, lowercase/1, uppercase/1, compare/2, slice/3, crop/2, drop_start/2, drop_left/2, drop_end/2, drop_right/2, contains/2, starts_with/2, ends_with/2, split_once/2, append/2, concat/1, repeat/2, join/2, pad_start/3, pad_left/3, pad_end/3, pad_right/3, trim/1, trim_start/1, trim_left/1, trim_end/1, trim_right/1, pop_grapheme/1, to_graphemes/1, split/2, to_utf_codepoints/1, from_utf_codepoints/1, utf_codepoint/1, utf_codepoint_to_int/1, to_option/1, first/1, last/1, capitalise/1, inspect/1, byte_size/1]).
-export_type([direction/0]).

-type direction() :: leading | trailing | both.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 23).
-spec is_empty(binary()) -> boolean().
is_empty(Str) ->
    Str =:= <<""/utf8>>.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 49).
-spec length(binary()) -> integer().
length(String) ->
    string:length(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 73).
-spec do_reverse(binary()) -> binary().
do_reverse(String) ->
    _pipe = String,
    _pipe@1 = gleam@string_tree:from_string(_pipe),
    _pipe@2 = gleam@string_tree:reverse(_pipe@1),
    gleam@string_tree:to_string(_pipe@2).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 69).
-spec reverse(binary()) -> binary().
reverse(String) ->
    do_reverse(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 94).
-spec replace(binary(), binary(), binary()) -> binary().
replace(String, Pattern, Substitute) ->
    _pipe = String,
    _pipe@1 = gleam@string_tree:from_string(_pipe),
    _pipe@2 = gleam_stdlib:string_replace(_pipe@1, Pattern, Substitute),
    gleam@string_tree:to_string(_pipe@2).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 117).
-spec lowercase(binary()) -> binary().
lowercase(String) ->
    string:lowercase(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 137).
-spec uppercase(binary()) -> binary().
uppercase(String) ->
    string:uppercase(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 161).
-spec compare(binary(), binary()) -> gleam@order:order().
compare(A, B) ->
    case A =:= B of
        true ->
            eq;

        _ ->
            case gleam_stdlib:less_than(A, B) of
                true ->
                    lt;

                _ ->
                    gt
            end
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 206).
-spec slice(binary(), integer(), integer()) -> binary().
slice(String, Idx, Len) ->
    case Len < 0 of
        true ->
            <<""/utf8>>;

        false ->
            case Idx < 0 of
                true ->
                    Translated_idx = length(String) + Idx,
                    case Translated_idx < 0 of
                        true ->
                            <<""/utf8>>;

                        false ->
                            gleam_stdlib:slice(String, Translated_idx, Len)
                    end;

                false ->
                    gleam_stdlib:slice(String, Idx, Len)
            end
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 239).
-spec crop(binary(), binary()) -> binary().
crop(String, Substring) ->
    gleam_stdlib:crop_string(String, Substring).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 264).
-spec drop_start(binary(), integer()) -> binary().
drop_start(String, Num_graphemes) ->
    case Num_graphemes < 0 of
        true ->
            String;

        false ->
            slice(String, Num_graphemes, length(String) - Num_graphemes)
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 251).
-spec drop_left(binary(), integer()) -> binary().
drop_left(String, Num_graphemes) ->
    drop_start(String, Num_graphemes).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 294).
-spec drop_end(binary(), integer()) -> binary().
drop_end(String, Num_graphemes) ->
    case Num_graphemes < 0 of
        true ->
            String;

        false ->
            slice(String, 0, length(String) - Num_graphemes)
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 281).
-spec drop_right(binary(), integer()) -> binary().
drop_right(String, Num_graphemes) ->
    drop_end(String, Num_graphemes).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 322).
-spec contains(binary(), binary()) -> boolean().
contains(Haystack, Needle) ->
    gleam_stdlib:contains_string(Haystack, Needle).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 333).
-spec starts_with(binary(), binary()) -> boolean().
starts_with(String, Prefix) ->
    gleam_stdlib:string_starts_with(String, Prefix).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 350).
-spec ends_with(binary(), binary()) -> boolean().
ends_with(String, Suffix) ->
    gleam_stdlib:string_ends_with(String, Suffix).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 402).
-spec do_split_once(binary(), binary()) -> {ok, {binary(), binary()}} |
    {error, nil}.
do_split_once(String, Substring) ->
    case string:split(String, Substring) of
        [First, Rest] ->
            {ok, {First, Rest}};

        _ ->
            {error, nil}
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 394).
-spec split_once(binary(), binary()) -> {ok, {binary(), binary()}} |
    {error, nil}.
split_once(String, Substring) ->
    do_split_once(String, Substring).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 428).
-spec append(binary(), binary()) -> binary().
append(First, Second) ->
    _pipe = First,
    _pipe@1 = gleam@string_tree:from_string(_pipe),
    _pipe@2 = gleam@string_tree:append(_pipe@1, Second),
    gleam@string_tree:to_string(_pipe@2).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 448).
-spec concat(list(binary())) -> binary().
concat(Strings) ->
    _pipe = Strings,
    _pipe@1 = gleam@string_tree:from_strings(_pipe),
    gleam@string_tree:to_string(_pipe@1).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 469).
-spec repeat_loop(binary(), integer(), binary()) -> binary().
repeat_loop(String, Times, Acc) ->
    case Times =< 0 of
        true ->
            Acc;

        false ->
            repeat_loop(String, Times - 1, <<Acc/binary, String/binary>>)
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 465).
-spec repeat(binary(), integer()) -> binary().
repeat(String, Times) ->
    repeat_loop(String, Times, <<""/utf8>>).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 492).
-spec do_join(list(binary()), binary()) -> binary().
do_join(Strings, Separator) ->
    _pipe = Strings,
    _pipe@1 = gleam@list:intersperse(_pipe, Separator),
    concat(_pipe@1).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 487).
-spec join(list(binary()), binary()) -> binary().
join(Strings, Separator) ->
    do_join(Strings, Separator).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 620).
-spec padding(integer(), binary()) -> binary().
padding(Size, Pad_string) ->
    Pad_string_length = length(Pad_string),
    Num_pads = case Pad_string_length of
        0 -> 0;
        Gleam@denominator -> Size div Gleam@denominator
    end,
    Extra = case Pad_string_length of
        0 -> 0;
        Gleam@denominator@1 -> Size rem Gleam@denominator@1
    end,
    <<(repeat(Pad_string, Num_pads))/binary,
        (slice(Pad_string, 0, Extra))/binary>>.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 545).
-spec pad_start(binary(), integer(), binary()) -> binary().
pad_start(String, Desired_length, Pad_string) ->
    Current_length = length(String),
    To_pad_length = Desired_length - Current_length,
    case To_pad_length =< 0 of
        true ->
            String;

        false ->
            <<(padding(To_pad_length, Pad_string))/binary, String/binary>>
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 518).
-spec pad_left(binary(), integer(), binary()) -> binary().
pad_left(String, Desired_length, Pad_string) ->
    pad_start(String, Desired_length, Pad_string).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 606).
-spec pad_end(binary(), integer(), binary()) -> binary().
pad_end(String, Desired_length, Pad_string) ->
    Current_length = length(String),
    To_pad_length = Desired_length - Current_length,
    case To_pad_length =< 0 of
        true ->
            String;

        false ->
            <<String/binary, (padding(To_pad_length, Pad_string))/binary>>
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 579).
-spec pad_right(binary(), integer(), binary()) -> binary().
pad_right(String, Desired_length, Pad_string) ->
    pad_end(String, Desired_length, Pad_string).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 647).
-spec do_trim(binary()) -> binary().
do_trim(String) ->
    string:trim(String, both).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 642).
-spec trim(binary()) -> binary().
trim(String) ->
    do_trim(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 688).
-spec do_trim_start(binary()) -> binary().
do_trim_start(String) ->
    string:trim(String, leading).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 683).
-spec trim_start(binary()) -> binary().
trim_start(String) ->
    do_trim_start(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 670).
-spec trim_left(binary()) -> binary().
trim_left(String) ->
    trim_start(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 720).
-spec do_trim_end(binary()) -> binary().
do_trim_end(String) ->
    string:trim(String, trailing).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 715).
-spec trim_end(binary()) -> binary().
trim_end(String) ->
    do_trim_end(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 702).
-spec trim_right(binary()) -> binary().
trim_right(String) ->
    trim_end(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 743).
-spec pop_grapheme(binary()) -> {ok, {binary(), binary()}} | {error, nil}.
pop_grapheme(String) ->
    gleam_stdlib:string_pop_grapheme(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 765).
-spec to_graphemes_loop(binary(), list(binary())) -> list(binary()).
to_graphemes_loop(String, Acc) ->
    case pop_grapheme(String) of
        {ok, {Grapheme, Rest}} ->
            to_graphemes_loop(Rest, [Grapheme | Acc]);

        _ ->
            Acc
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 760).
-spec to_graphemes(binary()) -> list(binary()).
to_graphemes(String) ->
    _pipe = to_graphemes_loop(String, []),
    lists:reverse(_pipe).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 367).
-spec split(binary(), binary()) -> list(binary()).
split(X, Substring) ->
    case Substring of
        <<""/utf8>> ->
            to_graphemes(X);

        _ ->
            _pipe = X,
            _pipe@1 = gleam@string_tree:from_string(_pipe),
            _pipe@2 = gleam@string_tree:split(_pipe@1, Substring),
            gleam@list:map(_pipe@2, fun gleam@string_tree:to_string/1)
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 812).
-spec to_utf_codepoints_loop(bitstring(), list(integer())) -> list(integer()).
to_utf_codepoints_loop(Bit_array, Acc) ->
    case Bit_array of
        <<First/utf8, Rest/binary>> ->
            to_utf_codepoints_loop(Rest, [First | Acc]);

        _ ->
            lists:reverse(Acc)
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 807).
-spec do_to_utf_codepoints(binary()) -> list(integer()).
do_to_utf_codepoints(String) ->
    to_utf_codepoints_loop(<<String/binary>>, []).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 802).
-spec to_utf_codepoints(binary()) -> list(integer()).
to_utf_codepoints(String) ->
    do_to_utf_codepoints(String).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 852).
-spec from_utf_codepoints(list(integer())) -> binary().
from_utf_codepoints(Utf_codepoints) ->
    gleam_stdlib:utf_codepoint_list_to_string(Utf_codepoints).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 858).
-spec utf_codepoint(integer()) -> {ok, integer()} | {error, nil}.
utf_codepoint(Value) ->
    case Value of
        I when I > 1114111 ->
            {error, nil};

        65534 ->
            {error, nil};

        65535 ->
            {error, nil};

        I@1 when (I@1 >= 55296) andalso (I@1 =< 57343) ->
            {error, nil};

        I@2 ->
            {ok, gleam_stdlib:identity(I@2)}
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 877).
-spec utf_codepoint_to_int(integer()) -> integer().
utf_codepoint_to_int(Cp) ->
    gleam_stdlib:identity(Cp).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 900).
-spec to_option(binary()) -> gleam@option:option(binary()).
to_option(String) ->
    case String of
        <<""/utf8>> ->
            none;

        _ ->
            {some, String}
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 923).
-spec first(binary()) -> {ok, binary()} | {error, nil}.
first(String) ->
    case pop_grapheme(String) of
        {ok, {First, _}} ->
            {ok, First};

        {error, E} ->
            {error, E}
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 946).
-spec last(binary()) -> {ok, binary()} | {error, nil}.
last(String) ->
    case pop_grapheme(String) of
        {ok, {First, <<""/utf8>>}} ->
            {ok, First};

        {ok, {_, Rest}} ->
            {ok, slice(Rest, -1, 1)};

        {error, E} ->
            {error, E}
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 964).
-spec capitalise(binary()) -> binary().
capitalise(String) ->
    case pop_grapheme(String) of
        {ok, {First, Rest}} ->
            append(uppercase(First), lowercase(Rest));

        _ ->
            <<""/utf8>>
    end.

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 973).
-spec inspect(any()) -> binary().
inspect(Term) ->
    _pipe = gleam_stdlib:inspect(Term),
    gleam@string_tree:to_string(_pipe).

-file("/Users/louis/src/gleam/stdlib/src/gleam/string.gleam", 996).
-spec byte_size(binary()) -> integer().
byte_size(String) ->
    erlang:byte_size(String).
Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT