• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
      • B*
      • Defunc
      • Fty
        • Deftagsum
        • Defprod
        • Defflexsum
        • Defbitstruct
        • Deflist
        • Defalist
        • Defbyte
        • Deffixequiv
        • Defresult
          • Reserr
          • Reserr-option
            • Reserr-optionp
            • Reserr-option-fix
            • Reserr-option-case
            • Reserr-option-equiv
            • Reserr-option-some
            • Reserr-option-none
          • Patbind-ok
          • Reserrf-push
          • Defresult-macro-definition
          • Reserrf
          • Patbind-okf
        • Deffixtype
        • Defoption
        • Fty-discipline
        • Fold
        • Fty-extensions
        • Defsubtype
        • Defset
        • Deftypes
        • Specific-types
        • Defflatsum
        • Deflist-of-len
        • Defbytelist
        • Fty::basetypes
        • Defomap
        • Defvisitors
        • Deffixtype-alias
        • Deffixequiv-sk
        • Defunit
        • Multicase
        • Deffixequiv-mutual
        • Fty::baselists
        • Def-enumcase
        • Defmap
      • Apt
      • Std/util
      • Defdata
      • Defrstobj
      • Seq
      • Match-tree
      • Defrstobj
      • With-supporters
      • Def-partial-measure
      • Template-subst
      • Soft
      • Defthm-domain
      • Event-macros
      • Def-universal-equiv
      • Def-saved-obligs
      • With-supporters-after
      • Definec
      • Sig
      • Outer-local
      • Data-structures
    • ACL2
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
    • Math
    • Testing-utilities
  • Defresult

Reserr-option

Fixtype of optional error results.

This is an option type introduced by defoption. Note that defoption is just a wrapper for defflexsum, so there are :none and :some member types, a case macro, and so forth.

Member Types
:none → reserr-option-none
Represents that no reserr-option is available, i.e., Nothing or None.
:some → reserr-option-some
An available reserr-option, i.e., Just val or Some val.

This can be used for results that either are errors or carry no information otherwise. That is, nil is the (only) good result.

Subtopics

Reserr-optionp
Recognizer for reserr-option structures.
Reserr-option-fix
Fixing function for reserr-option structures.
Reserr-option-case
Case macro for the different kinds of reserr-option structures.
Reserr-option-equiv
Basic equivalence relation for reserr-option structures.
Reserr-option-some
An available reserr-option, i.e., Just val or Some val.
Reserr-option-none
Represents that no reserr-option is available, i.e., Nothing or None.