code.consxy.com Git - sheep/blob - resources/success1.md

   1 ## Function **FUNC-THAT-DOES-STUFF**
   2
   3 #### Syntax:
   4
   5 **func-that-does-stuff** _path_ _x_ => _result_
   6
   7 ```result::= success-result | failure-result```
   8 ```success-result::= (:success filename)```
   9 ```failure-result::= (:failure filename msg)```
  10
  11 #### Arguments and Values:
  12
  13 _path_---a pathname
  14 _x_---a random value related to _path_
  15 _filename_---the file this func was run on
  16 _msg_---a string containing the failure message
  17
  18 #### Description:
  19
  20 _func-that-does-stuff_ runs all the things against a file and returns as soon as the first func error is found.
  21
  22 This second section uses _path_ and _x_ as something we should talk about, but doesn't use all the arguments (let's include _path_ here for fun)
  23
  24 #### Examples:
  25
  26 ```(func-that-does-stuff #P"path/to/file.lisp" t)``` => ```(:success "path/to/file.lisp")```
  27 ```(func-that-does-stuff #P"path/to/error.lisp" nil)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
  28
  29 ## Function **HAS-KEYWORDS**
  30
  31 #### Syntax:
  32
  33 **has-keywords** _path_ _&key_ _x_ => _result_
  34
  35 ```result::= success-result | failure-result```
  36 ```success-result::= (:success filename)```
  37 ```failure-result::= (:failure filename msg)```
  38
  39 #### Arguments and Values:
  40
  41 _path_---a pathname
  42 _x_---a random value related to _path_
  43 _filename_---the file this func was run on
  44 _msg_---a string containing the failure message
  45
  46 #### Description:
  47
  48 _has-keywords_ runs all the things against a file and returns as soon as the first func error is found.
  49
  50 This second section uses _path_ and _x_ as something we should talk about, but doesn't use all the arguments (let's include _path_ here for fun)
  51
  52 ## Function **HAS-NO-EXAMPLES**
  53
  54 #### Syntax:
  55
  56 **has-no-examples** => _result_
  57
  58 ```result::= success-result | failure-result```
  59 ```success-result::= (:success filename)```
  60 ```failure-result::= (:failure filename msg)```
  61
  62 #### Arguments and Values:
  63
  64 _filename_---the file this func was run on
  65 _msg_---a string containing the failure message
  66
  67 #### Description:
  68
  69 _has-no-examples_ runs all the things against a file and returns as soon as the first func error is found.
  70
  71 ## Function **HAS-OPTIONAL**
  72
  73 #### Syntax:
  74
  75 **has-optional** _path_ _&optional_ _x_ => _result_
  76
  77 ```result::= success-result | failure-result```
  78 ```success-result::= (:success filename)```
  79 ```failure-result::= (:failure filename msg)```
  80
  81 #### Arguments and Values:
  82
  83 _path_---a pathname
  84 _x_---a random value related to _path_
  85 _filename_---the file this func was run on
  86 _msg_---a string containing the failure message
  87
  88 #### Description:
  89
  90 _has-optional_ runs all the things against a file and returns as soon as the first func error is found.
  91
  92 This second section uses _path_ and _x_ as something we should talk about, but doesn't use all the arguments (let's include _path_ here for fun)
  93
  94 ## Function **HAS-REST**
  95
  96 #### Syntax:
  97
  98 **has-rest** _path_ _&rest_ _x_ => _result_
  99
 100 ```result::= success-result | failure-result```
 101 ```success-result::= (:success filename)```
 102 ```failure-result::= (:failure filename msg)```
 103
 104 #### Arguments and Values:
 105
 106 _path_---a pathname
 107 _x_---a random value related to _path_
 108 _filename_---the file this func was run on
 109 _msg_---a string containing the failure message
 110
 111 #### Description:
 112
 113 _has-rest_ runs all the things against a file and returns as soon as the first func error is found.
 114
 115 This second section uses _path_ and _x_ as something we should talk about, but doesn't use all the arguments (let's include _path_ here for fun)
 116
 117 ## Function **NOARGS**
 118
 119 #### Syntax:
 120
 121 **noargs** => _result_
 122
 123 ```result::= success-result | failure-result```
 124 ```success-result::= (:success filename)```
 125 ```failure-result::= (:failure filename msg)```
 126
 127 #### Arguments and Values:
 128
 129 _filename_---the file this func was run on
 130 _msg_---a string containing the failure message
 131
 132 #### Description:
 133
 134 _noargs_ runs all the things against a file and returns as soon as the first func error is found.
 135
 136 #### Examples:
 137
 138 ```(func-that-does-stuff)``` => ```(:success "path/to/file.lisp")```
 139 ```(func-that-does-stuff)``` => ```(:failure "path/to/error.lisp" "Error msg" 20 0)```
 140
 141 ## Function **RESULT-LIST**
 142
 143 #### Syntax:
 144
 145 **result-list** => _result_
 146
 147 ```result::= failure-result*```
 148 ```failure-result::= (:failure filename msg)```
 149
 150 #### Arguments and Values:
 151
 152 _filename_---the file this func was run on
 153 _msg_---a string containing the failure message
 154
 155 #### Description:
 156
 157 NOARGS runs all the things against a file and returns as soon as the first func error is found.
 158
 159 ## Function **VALUES-RESULT**
 160
 161 #### Syntax:
 162
 163 **values-result** => _result1_, _result2_, _result3_
 164
 165 ```result1::= success-result | failure-result```
 166 ```success-result::= (:success filename)```
 167 ```failure-result::= (:failure filename msg)```
 168
 169 #### Arguments and Values:
 170
 171 _result2_---second result
 172 _result3_---third result
 173 _filename_---the file this func was run on
 174 _msg_---a string containing the failure message
 175
 176 #### Description:
 177
 178 _values-result_ runs all the things against a file and returns as soon as the first func error is found.