• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • 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
          • World
          • Io
            • Fmt
            • Msg
            • Cw
            • Set-evisc-tuple
            • Set-iprint
            • Print-control
            • Read-file-into-string
            • Std/io
            • Msgp
            • Printing-to-strings
            • Evisc-tuple
            • Output-controls
            • Observation
            • *standard-co*
            • Ppr-special-syms
            • Standard-oi
            • Standard-co
            • Without-evisc
            • Serialize
              • With-serialize-character
              • Unsound-read
              • Serialize-read
                • Serialize-in-books
                • Print-compressed
                • Print-legibly
                • Serialize-write
                • Set-serialize-character-system
                • Serialize-alternatives
              • Output-to-file
              • Fmt-to-comment-window
              • 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
            • Wormhole
            • Programming-with-state
            • W
            • Set-state-ok
            • Random$
          • Mutual-recursion
          • Memoize
          • Mbe
          • Io
            • Fmt
            • Msg
            • Cw
            • Set-evisc-tuple
            • Set-iprint
            • Print-control
            • Read-file-into-string
            • Std/io
            • Msgp
            • Printing-to-strings
            • Evisc-tuple
            • Output-controls
            • Observation
            • *standard-co*
            • Ppr-special-syms
            • Standard-oi
            • Standard-co
            • Without-evisc
            • Serialize
              • With-serialize-character
              • Unsound-read
              • Serialize-read
                • Serialize-in-books
                • Print-compressed
                • Print-legibly
                • Serialize-write
                • Set-serialize-character-system
                • Serialize-alternatives
              • Output-to-file
              • Fmt-to-comment-window
              • 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$
            • Defmacro
            • Loop$-primer
            • Fast-alists
            • Defconst
            • 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
          • Debugging
          • Miscellaneous
          • Output-controls
          • Macros
          • Interfacing-tools
        • Interfacing-tools
        • Hardware-verification
        • Software-verification
        • Math
        • Testing-utilities
      • Serialize
      • ACL2-built-ins

      Serialize-read

      Read a serialized ACL2 object from a file

      General form:

      (serialize-read filename
                      [:hons-mode {:always, :never, :smart}]   ; :smart by default
                      [:verbosep  {t, nil}])                   ; nil by default
       -->
      (mv obj state)

      In the logic this is an oracle read.

      Under the hood, we try to read and return a serialized object from a file that was presumably created by serialize-write. On success we return the contents of the file. Any failures (e.g., file not found, bad file contents, etc.) will result in a hard Lisp error.

      The filename should be a string that gives the path to the file.

      The hons-mode controls how whether to use hons or cons to restore the object. The default mode is :smart, which means that conses that were normed at the time of the file's creation should be restored with hons. But you can override this and insist that hons is to :always or :never be used, instead.

      Why would you use :never? If your object previously had a lot of honses, but you no longer have any need for them to be normed, then using :never may sometimes be a lot faster since it can avoid hons calls. On the other hand, if you are going to hons-copy some part of the file's contents, then it is likely faster to use :smart or :always instead of first creating normal conses and then copying them to build honses.

      The :verbosep flag just controls whether to print some low-level details related to timing and memory usage as the file is being read.