• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Community
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
      • Theories
      • Rule-classes
      • Proof-builder
      • Recursion-and-induction
      • Hons-and-memoization
      • Events
      • Parallelism
      • History
      • Programming
        • Defun
        • Declare
        • System-utilities
        • Stobj
        • State
        • Mutual-recursion
        • Memoize
        • Mbe
        • Io
          • Fmt
          • Msg
          • Cw
          • Set-evisc-tuple
          • Set-iprint
          • Print-control
          • Read-file-into-string
          • Std/io
            • Open-channel-lemmas
            • Std/io/read-char$
            • Std/io/read-object
            • Std/io/open-output-channel
            • Unsound-read
            • Read-string
            • Read-bytes$
            • File-measure
            • Read-bytes$-n
              • Read-64ule-n
              • Read-64ube-n
              • Read-64sle-n
              • Read-64sbe-n
              • Read-32ule-n
              • Read-32ube-n
              • Read-32sle-n
              • Read-32sbe-n
              • Read-16ule-n
              • Read-16ube-n
              • Read-16sle-n
              • Read-16sbe-n
              • Read-byte$-n
              • Read-8s-n
            • Std/io/read-byte$
            • Std/io/open-input-channel
            • Read-file-lines-no-newlines
            • Print-compressed
            • Nthcdr-bytes
            • Read-file-lines
            • Std/io/close-output-channel
            • Read-file-characters
            • Read-file-bytes
            • Print-legibly
            • Std/io/close-input-channel
            • Read-file-objects
            • Logical-story-of-io
            • Take-bytes
            • Std/io/peek-char$
            • Read-file-characters-rev
            • Read-file-as-string
            • Std/io/write-byte$
            • Std/io/set-serialize-character
            • Std/io/print-object$
            • Std/io/princ$
            • Std/io/read-file-into-string
            • *file-types*
          • Msgp
          • Printing-to-strings
          • Evisc-tuple
          • Output-controls
          • Observation
          • *standard-co*
          • Standard-co
          • Ppr-special-syms
          • Standard-oi
          • Without-evisc
          • Serialize
          • Fmt-to-comment-window
          • Output-to-file
          • Princ$
          • Character-encoding
          • Open-output-channel!
          • Cw-print-base-radix
          • Set-print-case
          • Set-print-base
          • Print-object$
          • Extend-pathname
          • Print-object$+
          • Fmx-cw
          • Set-print-radix
          • Set-fmt-hard-right-margin
          • File-write-date$
          • Proofs-co
          • Set-print-base-radix
          • Print-base-p
          • *standard-oi*
          • Wof
          • File-length$
          • Fms!-lst
          • Delete-file$
          • *standard-ci*
          • Write-list
          • Trace-co
          • Fmt!
          • Fms
          • Cw!
          • Fmt-to-comment-window!
          • Fms!
          • Eviscerate-hide-terms
          • Fmt1!
          • Fmt-to-comment-window!+
          • Read-file-into-byte-array-stobj
          • Fmt1
          • Fmt-to-comment-window+
          • Cw-print-base-radix!
          • Read-file-into-character-array-stobj
          • Fmx
          • Cw!+
          • Read-objects-from-book
          • Newline
          • Cw+
          • Probe-file
          • Write-objects-to-file!
          • Write-objects-to-file
          • Read-objects-from-file
          • Read-object-from-file
          • Read-file-into-byte-list
          • Set-fmt-soft-right-margin
          • Read-file-into-character-list
          • Io-utilities
        • Defpkg
        • Apply$
        • Loop$
        • Programming-with-state
        • Arrays
        • Characters
        • Time$
        • Defconst
        • Fast-alists
        • Defmacro
        • Loop$-primer
        • Evaluation
        • Guard
        • Equality-variants
        • Compilation
        • Hons
        • ACL2-built-ins
        • Developers-guide
        • System-attachments
        • Advanced-features
        • Set-check-invariant-risk
        • Numbers
        • Efficiency
        • Irrelevant-formals
        • Introduction-to-programming-in-ACL2-for-those-who-know-lisp
        • Redefining-programs
        • Lists
        • Invariant-risk
        • Errors
        • Defabbrev
        • Conses
        • Alists
        • Set-register-invariant-risk
        • Strings
        • Program-wrapper
        • Get-internal-time
        • Basics
        • Packages
        • Oracle-eval
        • Defmacro-untouchable
        • <<
        • Primitive
        • Revert-world
        • Unmemoize
        • Set-duplicate-keys-action
        • Symbols
        • Def-list-constructor
        • Easy-simplify-term
        • Defiteration
        • Fake-oracle-eval
        • Defopen
        • Sleep
      • Operational-semantics
      • Real
      • Start-here
      • Miscellaneous
      • Output-controls
      • Bdd
      • Macros
      • Installation
      • Mailing-lists
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
    • Math
    • Testing-utilities
  • Std/io

Read-bytes$-n

Flexible macro for reading whole lists of n 1-, 2-, 4-, or 8-byte values from an open :byte input stream.

General form:

(read-bytes$-n n channel
               [:bytes bytes]     ;; default: 1
               [:signed signed]   ;; default: nil
               [:end end]         ;; default: :big
               )

The bytes, signed, and end arguments are as in read-bytes$.

The number n says how many values to read. The actual number of bytes that will be read is therefore n * bytes. E.g., reading three 8-byte values will consume a total of 24 bytes from the input stream.

If EOF is reached before n * bytes bytes are read from the stream, then we return fail. Otherwise, we return an n-element list, where every member is an appropriate integer for this combination of signedness and size.

Subtopics

Read-64ule-n
(read-64ule-n n channel state) reads n 64-bit, unsigned, little-endian values from the input channel and returns them as a list.
Read-64ube-n
(read-64ube-n n channel state) reads n 64-bit, unsigned, big-endian values from the input channel and returns them as a list.
Read-64sle-n
(read-64sle-n n channel state) reads n 64-bit, signed, little-endian values from the input channel and returns them as a list.
Read-64sbe-n
(read-64sbe-n n channel state) reads n 64-bit, signed, big-endian values from the input channel and returns them as a list.
Read-32ule-n
(read-32ule-n n channel state) reads n 32-bit, unsigned, little-endian values from the input channel and returns them as a list.
Read-32ube-n
(read-32ube-n n channel state) reads n 32-bit, unsigned, big-endian values from the input channel and returns them as a list.
Read-32sle-n
(read-32sle-n n channel state) reads n 32-bit, signed, little-endian values from the input channel and returns them as a list.
Read-32sbe-n
(read-32sbe-n n channel state) reads n 32-bit, signed, big-endian values from the input channel and returns them as a list.
Read-16ule-n
(read-16ule-n n channel state) reads n 16-bit, unsigned, little-endian values from the input channel and returns them as a list.
Read-16ube-n
(read-16ube-n n channel state) reads n 16-bit, unsigned, big-endian values from the input channel and returns them as a list.
Read-16sle-n
(read-16sle-n n channel state) reads n 16-bit, signed, little-endian values from the input channel and returns them as a list.
Read-16sbe-n
(read-16sbe-n n channel state) reads n 16-bit, signed, big-endian values from the input channel and returns them as a list.
Read-byte$-n
(read-byte$-n n channel state) reads n unsigned bytes from the input channel and returns them as a list.
Read-8s-n
(read-8s-n n channel state) reads n signed bytes from the input channel and returns them as a list.