nibbles

API Reference

nibbles

A library for accessing octet-addressed blocks of data in big- and little-endian orders

NIBBLES

  • Type OCTET
  • Type INDEX
  • Type OCTET-VECTOR (&optional (length '*))
  • Function MAKE-OCTET-VECTOR (count &key (initial-element 0))
    Make and return an `octet-vector' with COUNT elements. If supplied, INITIAL-ELEMENT is used to populate the vector. The value of INITIAL-ELEMENT has to of type `octet'.
  • Function OCTET-VECTOR (&rest args)
    Make and return an `octet-vector' containing the elements ARGS. ARGS have to be of type `octet'.
  • Type SIMPLE-OCTET-VECTOR (&optional (length '*))
  • Function UB16REF/LE (vector index)
  • Function UB16REF/BE (vector index)
  • Function SB16REF/LE (vector index)
  • Function SB16REF/BE (vector index)
  • Function UB32REF/LE (vector index)
  • Function UB32REF/BE (vector index)
  • Function SB32REF/LE (vector index)
  • Function SB32REF/BE (vector index)
  • Function UB64REF/LE (vector index)
  • Function UB64REF/BE (vector index)
  • Function SB64REF/LE (vector index)
  • Function SB64REF/BE (vector index)
  • Function IEEE-SINGLE-REF/BE (vector index)
  • Function IEEE-SINGLE-REF/LE (vector index)
  • Function IEEE-DOUBLE-REF/BE (vector index)
  • Function IEEE-DOUBLE-REF/LE (vector index)
  • Function WRITE-UB16/LE (integer stream)
  • Function WRITE-UB16/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 16-bit unsigned integers in little-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-UB16/BE (integer stream)
  • Function WRITE-UB16/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 16-bit unsigned integers in big-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-SB16/LE (integer stream)
  • Function WRITE-SB16/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 16-bit signed integers in little-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-SB16/BE (integer stream)
  • Function WRITE-SB16/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 16-bit signed integers in big-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB16/LE (stream)
  • Function READ-UB16/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 16-bit unsigned integer read in little-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB16/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 16-bit unsigned integer read in little-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB16/BE (stream)
  • Function READ-UB16/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 16-bit unsigned integer read in big-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB16/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 16-bit unsigned integer read in big-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB16/LE (stream)
  • Function READ-SB16/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 16-bit signed integer read in little-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB16/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 16-bit signed integer read in little-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB16/BE (stream)
  • Function READ-SB16/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 16-bit signed integer read in big-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB16/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 16-bit signed integer read in big-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-UB32/LE (integer stream)
  • Function WRITE-UB32/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 32-bit unsigned integers in little-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-UB32/BE (integer stream)
  • Function WRITE-UB32/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 32-bit unsigned integers in big-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-SB32/LE (integer stream)
  • Function WRITE-SB32/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 32-bit signed integers in little-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-SB32/BE (integer stream)
  • Function WRITE-SB32/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 32-bit signed integers in big-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB32/LE (stream)
  • Function READ-UB32/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 32-bit unsigned integer read in little-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB32/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 32-bit unsigned integer read in little-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB32/BE (stream)
  • Function READ-UB32/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 32-bit unsigned integer read in big-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB32/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 32-bit unsigned integer read in big-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB32/LE (stream)
  • Function READ-SB32/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 32-bit signed integer read in little-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB32/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 32-bit signed integer read in little-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB32/BE (stream)
  • Function READ-SB32/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 32-bit signed integer read in big-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB32/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 32-bit signed integer read in big-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-UB64/LE (integer stream)
  • Function WRITE-UB64/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 64-bit unsigned integers in little-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-UB64/BE (integer stream)
  • Function WRITE-UB64/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 64-bit unsigned integers in big-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-SB64/LE (integer stream)
  • Function WRITE-SB64/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 64-bit signed integers in little-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-SB64/BE (integer stream)
  • Function WRITE-SB64/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as 64-bit signed integers in big-endian order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB64/LE (stream)
  • Function READ-UB64/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 64-bit unsigned integer read in little-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB64/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 64-bit unsigned integer read in little-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB64/BE (stream)
  • Function READ-UB64/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 64-bit unsigned integer read in big-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-UB64/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 64-bit unsigned integer read in big-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB64/LE (stream)
  • Function READ-SB64/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 64-bit signed integer read in little-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB64/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 64-bit signed integer read in little-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB64/BE (stream)
  • Function READ-SB64/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a 64-bit signed integer read in big-endian order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-SB64/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a 64-bit signed integer read in big-endian order. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-IEEE-SINGLE/LE (float stream)
  • Function WRITE-IEEE-SINGLE/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as SINGLE-FLOATs in little-endian byte order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-IEEE-SINGLE/BE (float stream)
  • Function WRITE-IEEE-SINGLE/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as SINGLE-FLOATs in big-endian byte order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-SINGLE/LE (stream)
  • Function READ-IEEE-SINGLE/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a SINGLE-FLOAT read in little-endian byte order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-SINGLE/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a SINGLE-FLOAT read in little-endian byte order. SEQ may be either a vector or a list. STREAM must have na element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-SINGLE/BE (stream)
  • Function READ-IEEE-SINGLE/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a SINGLE-FLOAT read in big-endian byte order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-SINGLE/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a SINGLE-FLOAT read in big-endian byte order. SEQ may be either a vector or a list. STREAM must have na element type of (UNSIGNED-BYTE 8).
  • Function WRITE-IEEE-DOUBLE/LE (float stream)
  • Function WRITE-IEEE-DOUBLE/LE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as DOUBLE-FLOATs in little-endian byte order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function WRITE-IEEE-DOUBLE/BE (float stream)
  • Function WRITE-IEEE-DOUBLE/BE-SEQUENCE (seq stream &key (start 0) end)
    Write elements from SEQ between START and END as DOUBLE-FLOATs in big-endian byte order to STREAM. SEQ may be either a vector or a list. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-DOUBLE/LE (stream)
  • Function READ-IEEE-DOUBLE/LE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a DOUBLE-FLOAT read in little-endian byte order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-DOUBLE/LE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a DOUBLE-FLOAT read in little-endian byte order. SEQ may be either a vector or a list. STREAM must have na element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-DOUBLE/BE (stream)
  • Function READ-IEEE-DOUBLE/BE-SEQUENCE (result-type stream count)
    Return a sequence of type RESULT-TYPE, containing COUNT elements read from STREAM. Each element is a DOUBLE-FLOAT read in big-endian byte order. RESULT-TYPE must be either CL:VECTOR or CL:LIST. STREAM must have an element type of (UNSIGNED-BYTE 8).
  • Function READ-IEEE-DOUBLE/BE-INTO-SEQUENCE (seq stream &key (start 0) end)
    Destructively modify SEQ by replacing the elements of SEQ between START and END with elements read from STREAM. Each element is a DOUBLE-FLOAT read in big-endian byte order. SEQ may be either a vector or a list. STREAM must have na element type of (UNSIGNED-BYTE 8).