• Top
  • Documentation
  • Books
  • Recursion-and-induction
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
    • Std/lists
    • Std/alists
    • Obags
    • Std/util
    • Std/strings
    • 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
      • Std/io/read-byte$
      • Std/io/open-input-channel
      • Print-compressed
      • Read-file-lines-no-newlines
      • Nthcdr-bytes
      • Read-file-lines
      • Std/io/close-output-channel
      • Read-file-characters
      • Read-file-bytes
        • Read-byte$-all
      • 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*
    • Std/osets
    • Std/system
    • Std/basic
    • Std/typed-lists
    • Std/bitsets
    • Std/testing
    • Std/typed-alists
    • Std/stobjs
    • Std-extensions
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
  • Testing-utilities
  • Math

• Std/io

Read-file-bytes

Read an entire file into a list of (unsigned) bytes.

Signature: (read-file-bytes filename state) returns (mv contents state).

On success, contents is a list of bytes, 0-255, which captures the contents of the file.

On failure, e.g., perhaps filename does not exist, contents will be a stringp saying that we failed to open the file.

Definitions and Theorems

Function: read-file-bytes

(defun
     read-file-bytes (filename state)
     "Returns (MV ERRMSG/BYTES STATE)"
     (declare (xargs :guard (and (state-p state)
                                 (stringp filename))))
     (b* ((filename (mbe :logic (if (stringp filename) filename "")
                         :exec filename))
          ((mv channel state)
           (open-input-channel filename
                               :byte state))
          ((unless channel)
           (mv (concatenate 'string
                            "Error opening file " filename)
               state))
          ((mv data state)
           (read-byte$-all channel state))
          (state (close-input-channel channel state)))
         (mv data state)))

Theorem: state-p1-of-read-file-bytes

(defthm
   state-p1-of-read-file-bytes
   (implies (force (state-p1 state))
            (state-p1 (mv-nth 1 (read-file-bytes filename state)))))

Theorem: integer-listp-of-read-file-bytes

(defthm
  integer-listp-of-read-file-bytes
  (equal
       (integer-listp (mv-nth 0 (read-file-bytes filename state)))
       (not (stringp (mv-nth 0 (read-file-bytes filename state))))))

Theorem: nat-listp-of-read-file-bytes

(defthm
  nat-listp-of-read-file-bytes
  (equal
       (nat-listp (mv-nth 0 (read-file-bytes filename state)))
       (not (stringp (mv-nth 0 (read-file-bytes filename state))))))

Theorem: unsigned-byte-listp-of-read-file-bytes

(defthm
 unsigned-byte-listp-of-read-file-bytes
 (equal
   (unsigned-byte-listp 8
                        (mv-nth 0 (read-file-bytes filename state)))
   (not (stringp (mv-nth 0 (read-file-bytes filename state))))))

Theorem: type-of-read-file-bytes

(defthm type-of-read-file-bytes
        (or (true-listp (mv-nth 0 (read-file-bytes filename state)))
            (stringp (mv-nth 0 (read-file-bytes filename state))))
        :rule-classes :type-prescription)

Subtopics

Read-byte$-all

(read-byte$-all channel state) reads all remaining bytes from a file.