From ba980f1bf933f4fd2b66ab47bf31460402a7757e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?William=20Fank=20Thom=C3=A9?= Date: Mon, 5 Aug 2024 07:54:37 -0300 Subject: [PATCH] Rename `encode_iodata` to `encode_to_iodata` (#79) --- src/euneus.erl | 22 +++++++++++----------- test/euneus_SUITE.erl | 6 +++--- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/euneus.erl b/src/euneus.erl index ac34a0f..bf3f25f 100644 --- a/src/euneus.erl +++ b/src/euneus.erl @@ -6,8 +6,8 @@ -export([encode/1]). -export([encode/2]). --export([encode_iodata/1]). --export([encode_iodata/2]). +-export([encode_to_iodata/1]). +-export([encode_to_iodata/2]). -export([decode/1]). -export([decode/2]). -export([decode_iodata/1]). @@ -19,8 +19,8 @@ -ignore_xref([encode/1]). -ignore_xref([encode/2]). --ignore_xref([encode_iodata/1]). --ignore_xref([encode_iodata/2]). +-ignore_xref([encode_to_iodata/1]). +-ignore_xref([encode_to_iodata/2]). -ignore_xref([decode/1]). -ignore_xref([decode/2]). -ignore_xref([decode_iodata/1]). @@ -66,28 +66,28 @@ encode(Term) -> encode(Term, Opts) -> iolist_to_binary(euneus_encoder:encode(Term, Opts)). --spec encode_iodata(term()) -> iodata(). +-spec encode_to_iodata(term()) -> iodata(). %% @doc Encodes a term into an iodata JSON. %% %% Example: %% %% ``` -%% 1> euneus:encode_iodata(foo). +%% 1> euneus:encode_to_iodata(foo). %% [$", <<"foo">>, $"] %% ''' -encode_iodata(Term) -> - encode_iodata(Term, #{}). +encode_to_iodata(Term) -> + encode_to_iodata(Term, #{}). --spec encode_iodata(term(), euneus_encoder:options()) -> iodata(). +-spec encode_to_iodata(term(), euneus_encoder:options()) -> iodata(). %% @doc Encodes a term into an iodata JSON. %% %% Example: %% %% ``` -%% 1> euneus:encode_iodata(foo, #{}). +%% 1> euneus:encode_to_iodata(foo, #{}). %% [$", <<"foo">>, $"] %% ''' -encode_iodata(Term, Opts) -> +encode_to_iodata(Term, Opts) -> euneus_encoder:encode(Term, Opts). -spec decode(binary()) -> term(). diff --git a/test/euneus_SUITE.erl b/test/euneus_SUITE.erl index 58487a2..c853721 100644 --- a/test/euneus_SUITE.erl +++ b/test/euneus_SUITE.erl @@ -28,10 +28,10 @@ encode_test(Config) when is_list(Config) -> ?assertEqual(<<"[\"foo\"]">>, euneus:encode([foo], #{})) ]. -encode_iodata_test(Config) when is_list(Config) -> +encode_to_iodata_test(Config) when is_list(Config) -> [ - ?assertEqual([$[, [$", <<"foo">>, $"], $]], euneus:encode_iodata([foo])), - ?assertEqual([$[, [$", <<"foo">>, $"], $]], euneus:encode_iodata([foo], #{})) + ?assertEqual([$[, [$", <<"foo">>, $"], $]], euneus:encode_to_iodata([foo])), + ?assertEqual([$[, [$", <<"foo">>, $"], $]], euneus:encode_to_iodata([foo], #{})) ]. decode_test(Config) when is_list(Config) ->