Idris2Doc : FS.Internal.Bytes

FS.Internal.Bytes

(source)

Definitions

0 SnocBytes : Type
Totality: total
Visibility: public export
0 Bytes : Type
Totality: total
Visibility: public export
concatSnoc : SnocBytes -> ByteString
Totality: total
Visibility: export
nl : ByteString
Totality: total
Visibility: export
splitNL : ByteString -> ByteString -> (Maybe Bytes, ByteString)
Totality: total
Visibility: export
breakLastNL : ByteString -> ByteString -> (Maybe ByteString, ByteString)
Totality: total
Visibility: export
continuationBytes : Bits8 -> Maybe Nat
  The number of continuation bytes following a UTF-8 leading byte.

See [Wikipedia](https://en.wikipedia.org/wiki/UTF-8#Description)
for a description of the magic numbers used in the implementation
and the UTF-8 encoding in general.

Totality: total
Visibility: export
breakAtLastIncomplete : ByteString -> ByteString -> (Maybe ByteString, ByteString)
  Breaks a list of byte vectors at the last incomplete UTF-8 codepoint
The first list is a concatenation of all the complete UTF-8 strings,
while the second list contains the last incomplete codepoint (in case
of a valid UTF-8 string, the second list holds at most 3 bytes).

Totality: total
Visibility: export
data BSSRes : Type
  Result of splitting a byte string at a given substring

Totality: total
Visibility: public export
Constructors:
TooShort : ByteString -> BSSRes
  Input was too short. Will be passed on as a whole.
NoSS : ByteString -> ByteString -> BSSRes
  Substring not found. `pst` is one shorter than the substring in question,
because it might still end on a prefix of the substring.
SS : ByteString -> ByteString -> BSSRes
  Substring was found between `pre` and `pst`.

Hints:
Eq BSSRes
Show BSSRes
breakAtSS : ByteString -> ByteString -> BSSRes
Totality: total
Visibility: export