byte-sequence

TOC »

byte-sequence
- Description
- Library Procedures
  - Predicates
  - Constructors
  - Accessors
  - Transformers
  - Comparison
  - Searching
  - Subsequences
  - Fold
  - Find
  - I/O
  - SRFI-4 transformers
- Repository
- Version History
- License

Description

byte-sequence aims to provide a SRFI-1-inspired API for manipulating byte sequences encoded as bytevectors. In borrows inspiration from the Haskell bytestring library.

byte-sequence is the successor of the byte-blob egg. All procedures have been renamed from byte-blob-* to byte-sequence-*, and the conversion procedures blob->byte-blob and byte-blob->blob are now bytevector->byte-sequence and byte-sequence->bytevector.

Library Procedures

Predicates

byte-sequence? Xprocedure: Returns #t if the given object is a byte-sequence, #f otherwise.

byte-sequence-empty? BYTE-SEQUENCEprocedure: Returns #t if the given byte-sequence is empty, #f otherwise.

byte-sequence-valid-utf8? BYTE-SEQUENCEprocedure: Returns #t if the bytes of the given byte-sequence form a valid UTF-8 sequence, #f otherwise. The validation rejects malformed lead bytes, truncated sequences, UTF-16 surrogate code points (U+D800..U+DFFF), and encodings of values above U+10FFFF.

byte-sequence-is-prefix-of? PREFIX BYTE-SEQUENCEprocedure: Returns #t if PREFIX is a prefix of BYTE-SEQUENCE, #f otherwise.

byte-sequence-is-suffix-of? SUFFIX BYTE-SEQUENCEprocedure: Returns #t if SUFFIX is a suffix of BYTE-SEQUENCE, #f otherwise.

Constructors

byte-sequence-emptyprocedure: Returns an empty byte-sequence.

byte-sequence-replicate N Vprocedure: Returns a byte-sequence of length N, where each element is V.

byte-sequence-cons X BYTE-SEQUENCEprocedure: Analogous to list cons, but of complexity O(N), as it requires copying the elements of the byte-sequence argument.

byte-sequence-snoc BYTE-SEQUENCE Xprocedure: Analogous to byte-sequence-cons, but appends X at the end of the given byte-sequence. Of complexity O(N), as it requires copying the elements of the byte-sequence argument.

byte-sequence-singleton Xprocedure: Returns a byte-sequence of length 1 containing the byte X.

bytevector->byte-sequence BYTEVECTORprocedure: Returns a byte-sequence containing the elements of the given bytevector.

list->byte-sequence LISTprocedure: Returns a byte-sequence containing the elements of LIST.

string->byte-sequence STRINGprocedure: Returns a byte-sequence containing the elements of STRING.

Accessors

byte-sequence-length BYTE-SEQUENCEprocedure: Returns the number of elements contained in the given byte-sequence.

byte-sequence-car BYTE-SEQUENCEprocedure: Returns the first element of a byte-sequence. The argument byte-sequence must be non-empty, or an exception will be thrown.

byte-sequence-cdr BYTE-SEQUENCEprocedure: Returns a byte-sequence that contains the elements after the first element of the given byte-sequence. The argument byte-sequence must be non-empty, or an exception will be thrown.

byte-sequence-last BYTE-SEQUENCEprocedure: Returns the last element of a byte-sequence. The argument byte-sequence must be non-empty, or an exception will be thrown.

byte-sequence-init BYTE-SEQUENCEprocedure: Returns a byte-sequence that contains all elements except the last element of the given byte-sequence. The argument byte-sequence must be non-empty, or an exception will be thrown.

byte-sequence-uncons BYTE-SEQUENCEprocedure: Returns two values, the first element of the given byte-sequence and a byte-sequence containing the remaining elements. Returns #f if the byte-sequence is empty.

byte-sequence-unsnoc BYTE-SEQUENCEprocedure: Returns two values, a byte-sequence containing all elements except the last, and the last element of the given byte-sequence. Returns #f if the byte-sequence is empty.

byte-sequence-ref BYTE-SEQUENCE Iprocedure: Returns the i-th element of the given byte-sequence as a signed byte.

byte-sequence-uref BYTE-SEQUENCE Iprocedure: Returns the i-th element of the given byte-sequence as an unsigned byte.

byte-sequence-index-maybe BYTE-SEQUENCE Iprocedure: Returns the i-th element of the given byte-sequence as an unsigned byte, or #f if I is out of range.

Transformers

byte-sequence-set! BYTE-SEQUENCE I Vprocedure: Sets the i-th element of the given byte-sequence to the signed byte V.

byte-sequence-uset! BYTE-SEQUENCE I Vprocedure: Sets the i-th element of the given byte-sequence to the unsigned byte V.

byte-sequence-append BYTE-SEQUENCE BYTE-SEQUENCEprocedure: Appends two byte-sequences together.

byte-sequence-reverse BYTE-SEQUENCEprocedure: Returns a byte-sequence that contains the elements of the given byte-sequence in reverse order.

byte-sequence-intersperse BYTE-SEQUENCE BYTEprocedure: Returns a byte-sequence with the given byte placed between the elements of the given byte-sequence.

byte-sequence-map F BYTE-SEQUENCEprocedure: Returns a byte-sequence obtained by applying F to each element of the given byte-sequence.

byte-sequence->bytevector BYTE-SEQUENCEprocedure: Returns the underlying Scheme bytevector object.

byte-sequence->list BYTE-SEQUENCE #!optional Fprocedure: Returns a list containing the elements of the given byte-sequence. If procedure F is provided as a second argument, it is applied to every element of the returned list.

byte-sequence->string BYTE-SEQUENCEprocedure: Returns a string containing the elements of the given byte-sequence.

Comparison

byte-sequence=? BYTE-SEQUENCE BYTE-SEQUENCEprocedure: Returns #t if the two byte-sequences contain the same sequence of bytes, #f otherwise.

byte-sequence-compare BYTE-SEQUENCE BYTE-SEQUENCEprocedure: Lexicographic comparison of two byte-sequences. Returns -1, 0, or 1 as the first argument is less than, equal to, or greater than the second.

Searching

byte-sequence-elem-index BYTE BYTE-SEQUENCEprocedure: Returns the index of the first occurrence of BYTE in the given byte-sequence, or #f if the byte-sequence does not contain it.

byte-sequence-elem-index-end BYTE BYTE-SEQUENCEprocedure: Returns the index of the last occurrence of BYTE in the given byte-sequence, or #f if the byte-sequence does not contain it.

byte-sequence-elem-indices BYTE BYTE-SEQUENCEprocedure: Returns a list of the indices of all occurrences of BYTE in the given byte-sequence, in increasing order.

byte-sequence-find-index F BYTE-SEQUENCEprocedure: Returns the index of the first byte in the given byte-sequence that satisfies the predicate F, or #f if no byte does.

byte-sequence-find-index-end F BYTE-SEQUENCEprocedure: Returns the index of the last byte in the given byte-sequence that satisfies the predicate F, or #f if no byte does.

byte-sequence-find-indices F BYTE-SEQUENCEprocedure: Returns a list of the indices of all bytes in the given byte-sequence that satisfy the predicate F, in increasing order.

byte-sequence-count BYTE BYTE-SEQUENCEprocedure: Returns the number of occurrences of BYTE in the given byte-sequence.

Subsequences

byte-sequence-take BYTE-SEQUENCE Nprocedure: Returns the prefix of the given byte-sequence of length N, or the entire byte-sequence if N is greater than its length.

byte-sequence-drop BYTE-SEQUENCE Nprocedure: Returns the suffix of the given byte-sequence after the first N elements.

byte-sequence-span BYTE-SEQUENCE START ENDprocedure: Returns the subsequence of the given byte-sequence from position START to position END.

byte-sequence-take-end BYTE-SEQUENCE Nprocedure: Returns the suffix of the given byte-sequence of length N, or the entire byte-sequence if N is greater than its length.

byte-sequence-drop-end BYTE-SEQUENCE Nprocedure: Returns the given byte-sequence with its last N elements removed, or the empty byte-sequence if N is greater than its length.

byte-sequence-split-at BYTE-SEQUENCE Nprocedure: Returns two values, the prefix of the given byte-sequence of length N and the remainder, as byte-sequences. If N is greater than the length of the byte-sequence, the prefix is the entire byte-sequence and the remainder is empty.

byte-sequence-take-while F BYTE-SEQUENCEprocedure: Returns the longest prefix of the given byte-sequence whose bytes all satisfy the predicate F.

byte-sequence-drop-while F BYTE-SEQUENCEprocedure: Returns the given byte-sequence with the longest prefix whose bytes all satisfy the predicate F removed.

byte-sequence-take-while-end F BYTE-SEQUENCEprocedure: Returns the longest suffix of the given byte-sequence whose bytes all satisfy the predicate F.

byte-sequence-drop-while-end F BYTE-SEQUENCEprocedure: Returns the given byte-sequence with its longest suffix whose bytes all satisfy the predicate F removed.

byte-sequence-span-while F BYTE-SEQUENCEprocedure: Returns two values, the longest prefix of the given byte-sequence whose bytes all satisfy the predicate F, and the remainder.

byte-sequence-break-while F BYTE-SEQUENCEprocedure: Returns two values, the longest prefix of the given byte-sequence whose bytes all fail the predicate F, and the remainder.

byte-sequence-span-while-end F BYTE-SEQUENCEprocedure: Returns two values, the longest suffix of the given byte-sequence whose bytes all satisfy the predicate F, and the rest.

byte-sequence-break-while-end F BYTE-SEQUENCEprocedure: Returns two values, the longest suffix of the given byte-sequence whose bytes all fail the predicate F, and the rest.

byte-sequence-strip-prefix PREFIX BYTE-SEQUENCEprocedure: Returns the remainder of BYTE-SEQUENCE without its first N bytes, if the first N bytes match PREFIX, #f otherwise.

byte-sequence-strip-suffix SUFFIX BYTE-SEQUENCEprocedure: Returns the prefix of BYTE-SEQUENCE without its last N bytes, if the last N bytes match SUFFIX, #f otherwise.

Fold

byte-sequence-fold-left F INIT BYTE-SEQUENCEprocedure
byte-sequence-fold-right F INIT BYTE-SEQUENCEprocedure: Given a procedure of two arguments, a starting value, and a byte-sequence, reduces the byte-sequence using the supplied procedure, from left to right, or right to left, respectively.

Find

byte-sequence-find NEEDLE HAYSTACKprocedure

Finds all non-overlapping instances of the byte-sequence NEEDLE in the byte-sequence HAYSTACK. The first element of the returned list is the prefix of HAYSTACK prior to any matches of NEEDLE. The second is a list of lists.

The first element of each pair in the list is a span from the beginning of a match to the beginning of the next match, while the second is a span from the beginning of the match to the end of the input.

I/O

file->byte-sequence FILENAME #!optional MODEprocedure

Returns a byte-sequence with the contents of the given file.

MODE is an optional argument that can be one of #:text or #:binary to specify text or binary mode on Windows.

byte-sequence->file FILENAME BYTE-SEQUENCE #!optional MODEprocedure

Writes the given byte-sequence to the file named by FILENAME.

MODE is an optional argument that is passed to call-with-output-file, so #:append can be used to append to an existing file.

byte-sequence-read PORT Nprocedure: Reads a byte-sequence of length N from the given port. Currently, the port must support the port->fileno procedure, which means that string ports are not supported (in that particular case, procedure string->byte-sequence can be used for converting strings to byte sequences).

byte-sequence-write PORT BYTE-SEQUENCEprocedure: Writes the given byte-sequence to the given port. Currently, the port must support the port->fileno procedure, which means that string ports are not supported (in that particular case, procedure string->byte-sequence can be used for converting strings to byte sequences).

SRFI-4 transformers

u8vector->byte-sequence U8VECTORprocedure
s8vector->byte-sequence S8VECTORprocedure
u16vector->byte-sequence U16VECTORprocedure
s16vector->byte-sequence S16VECTORprocedure
u32vector->byte-sequence U32VECTORprocedure
s32vector->byte-sequence S32VECTORprocedure
f32vector->byte-sequence F32VECTORprocedure
f64vector->byte-sequence F64VECTORprocedure
byte-sequence->u8vector BYTE-SEQUENCEprocedure
byte-sequence->s8vector BYTE-SEQUENCEprocedure
byte-sequence->u16vector BYTE-SEQUENCEprocedure
byte-sequence->s16vector BYTE-SEQUENCEprocedure
byte-sequence->u32vector BYTE-SEQUENCEprocedure
byte-sequence->s32vector BYTE-SEQUENCEprocedure
byte-sequence->f32vector BYTE-SEQUENCEprocedure
byte-sequence->f64vector BYTE-SEQUENCEprocedure: Note: in CHICKEN 6, u8vectors are represented directly as bytevectors, so byte-sequence->u8vector and byte-sequence->bytevector return the same kind of object.

Repository

https://github.com/iraikov/chicken-byte-blob

Version History

3.0 Renamed to byte-sequence. The procedures blob->byte-blob and byte-blob->blob are now bytevector->byte-sequence and byte-sequence->bytevector
2.5 Ported to CHICKEN 6; added several procedures inspired by the Haskell bytestring library
2.3 Previous byte-blob release
1.19 Ported to CHICKEN 5
1.18 Added optional mode argument to file->byte-blob (thanks to dthedens)
1.17 Added documentation for byte-blob->blob procedure (reported by retroj)
1.16 Remove files created by unit tests (thanks to mario)
1.15 Fixes for issues #1037 and #1038 (thanks to dthedens)
1.14 Bug fix in byte-blob-find
1.13 Added byte-blob-uref and byte-blob-uset! (thanks to Panos Stergiotis)
1.12 Fixed a bug in byte-blob-drop; added byte-blob-set! (thanks to Panos Stergiotis)
1.11 Updated test script to return proper exit code
1.9 Bug fix in byte-blob-find
1.8 Changed (import posix) to (require-extension posix)
1.7 Bug fix in byte-blob->string
1.6 Added optional second argument to byte-blob->list
1.5 Bug fixes in byte-blob-read and byte-blob-write
1.4 Added procedure blob->byte-blob
1.3 Fix in invocation of chicken_Panic
1.2 Added procedure byte-blob-ref
1.0 Initial release

License

Based on ideas from the Haskell bytestring library.

The code for byte-sequence-find is based on code from the Haskell Text library by Tom Harper and Bryan O'Sullivan.

 Copyright 2009-2026 Ivan Raikov, Dan Thedens.


 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as
 published by the Free Software Foundation, either version 3 of the
 License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 General Public License for more details.

 A full copy of the GPL license can be found at
 <http://www.gnu.org/licenses/>.

chickadee » byte-sequence

Identifier search