File 1307-More-precise-specs-for-some-binary-functio... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1307-More-precise-specs-for-some-binary-functions.patch of Package erlang (Revision 5bfcaba6253c6d17475b8ba23b952738)

Currently displaying revision 5bfcaba6253c6d17475b8ba23b952738 , Show latest

From 355d9776911b28191b7e603f4f1061dd2c5a6241 Mon Sep 17 00:00:00 2001
From: Maria Scott <maria-12648430@hnc-agency.org>
Date: Thu, 6 Jul 2023 11:28:54 +0200
Subject: [PATCH] More precise specs for some binary functions

---
 lib/stdlib/doc/src/binary.xml | 17 +++++++++--------
 lib/stdlib/src/binary.erl     | 31 ++++++++++++++++++++-----------
 2 files changed, 29 insertions(+), 19 deletions(-)

diff --git a/lib/stdlib/doc/src/binary.xml b/lib/stdlib/doc/src/binary.xml
index 6f55d6d327..5ed7babc7b 100644
--- a/lib/stdlib/doc/src/binary.xml
+++ b/lib/stdlib/doc/src/binary.xml
@@ -149,11 +149,12 @@
 only one element. The order of alternatives in a pattern is
 not significant.
 
- The list of binaries used for search alternatives must be flat and
- proper.
+ The list of binaries used for search alternatives must be flat,
+ proper and non-empty.
 
- If <c><anno>Pattern</anno></c> is not a binary or a flat proper list of
- binaries with length &gt; 0, a <c>badarg</c> exception is raised.
+ If <c><anno>Pattern</anno></c> is not a binary or a flat proper
+ non-empty list of binaries with length &gt; 0, a <c>badarg</c>
+ exception is raised.
 </desc>
 </func>
 
@@ -324,8 +325,8 @@
 2> binary:longest_common_prefix([&lt;&lt;"erlang"&gt;&gt;, &lt;&lt;"perl"&gt;&gt;]).
 0</code>
 
- If <c><anno>Binaries</anno></c> is not a flat list of binaries, a
- <c>badarg</c> exception is raised.
+ If <c><anno>Binaries</anno></c> is not a flat non-empty list of
+ binaries, a <c>badarg</c> exception is raised.
 </desc>
 </func>
 
@@ -345,8 +346,8 @@
 2> binary:longest_common_suffix([&lt;&lt;"erlang"&gt;&gt;, &lt;&lt;"perl"&gt;&gt;]).
 0</code>
 
- If <c>Binaries</c> is not a flat list of binaries, a <c>badarg</c>
- exception is raised.
+ If <c>Binaries</c> is not a flat non-empty list of binaries, a
+ <c>badarg</c> exception is raised.
 </desc>
 </func>
 
diff --git a/lib/stdlib/src/binary.erl b/lib/stdlib/src/binary.erl
index e587cfe98d..52e6cbda0a 100644
--- a/lib/stdlib/src/binary.erl
+++ b/lib/stdlib/src/binary.erl
@@ -108,7 +108,8 @@ bin_to_list(Subject, Pos, Len) ->
 binary_to_list(Subject, Pos + 1, Pos + Len).
 
 -spec compile_pattern(Pattern) -> cp() when
- Pattern :: binary() | [binary()].
+ Pattern :: PatternBinary | [PatternBinary,...],
+ PatternBinary :: <<_:8, _:_*8>>.
 
 compile_pattern(_) ->
 erlang:nif_error(undef).
@@ -173,20 +174,21 @@ list_to_bin(_) ->
 erlang:nif_error(undef).
 
 -spec longest_common_prefix(Binaries) -> non_neg_integer() when
- Binaries :: [binary()].
+ Binaries :: [binary(),...].
 
 longest_common_prefix(_) ->
 erlang:nif_error(undef).
 
 -spec longest_common_suffix(Binaries) -> non_neg_integer() when
- Binaries :: [binary()].
+ Binaries :: [binary(),...].
 
 longest_common_suffix(_) ->
 erlang:nif_error(undef).
 
 -spec match(Subject, Pattern) -> Found | nomatch when
 Subject :: binary(),
- Pattern :: binary() | [binary()] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Found :: part().
 
 match(_, _) ->
@@ -194,7 +196,8 @@ match(_, _) ->
 
 -spec match(Subject, Pattern, Options) -> Found | nomatch when
 Subject :: binary(),
- Pattern :: binary() | [binary()] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Found :: part(),
 Options :: [Option],
 Option :: {scope, part()}.
@@ -204,7 +207,8 @@ match(_, _, _) ->
 
 -spec matches(Subject, Pattern) -> Found when
 Subject :: binary(),
- Pattern :: binary() | [binary()] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Found :: [part()].
 
 matches(_, _) ->
@@ -212,7 +216,8 @@ matches(_, _) ->
 
 -spec matches(Subject, Pattern, Options) -> Found when
 Subject :: binary(),
- Pattern :: binary() | [binary()] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Found :: [part()],
 Options :: [Option],
 Option :: {scope, part()}.
@@ -243,7 +248,8 @@ referenced_byte_size(_) ->
 
 -spec split(Subject, Pattern) -> Parts when
 Subject :: binary(),
- Pattern :: binary() | [binary()] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Parts :: [binary()].
 
 split(_, _) ->
@@ -251,7 +257,8 @@ split(_, _) ->
 
 -spec split(Subject, Pattern, Options) -> Parts when
 Subject :: binary(),
- Pattern :: binary() | [binary()] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Options :: [Option],
 Option :: {scope, part()} | trim | global | trim_all,
 Parts :: [binary()].
@@ -267,7 +274,8 @@ split(_, _, _) ->
 
 -spec replace(Subject, Pattern, Replacement) -> Result when
 Subject :: binary(),
- Pattern :: binary() | [ binary() ] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Replacement :: binary(),
 Result :: binary().
 
@@ -281,7 +289,8 @@ replace(H,N,R) ->
 
 -spec replace(Subject, Pattern, Replacement, Options) -> Result when
 Subject :: binary(),
- Pattern :: binary() | [ binary() ] | cp(),
+ Pattern :: PatternBinary | [PatternBinary,...] | cp(),
+ PatternBinary :: <<_:8, _:_*8>>,
 Replacement :: binary(),
 Options :: [Option],
 Option :: global | {scope, part()} | {insert_replaced, InsPos},
-- 
2.35.3

Places

File 1307-More-precise-specs-for-some-binary-functions.patch of Package erlang (Revision 5bfcaba6253c6d17475b8ba23b952738)

Places