small change in documentation
This commit is contained in:
@@ -71,92 +71,7 @@ The final expression is used when no early return is taken.
|
||||
|
||||
@section{Contracted definitions}
|
||||
|
||||
@defform*[
|
||||
((define/contract/return (name . formals)
|
||||
(contract-part ... result-contract)
|
||||
body ...)
|
||||
(define/contract/return name
|
||||
result-contract
|
||||
value))
|
||||
]{
|
||||
|
||||
Like @racket[define/contract], but the body may use @racket[return].
|
||||
|
||||
The first form defines a contracted function. Ordinary results are checked by
|
||||
@racket[define/contract]. Early-returned values are checked separately
|
||||
against @racket[result-contract]. The implementation does this by defining a
|
||||
small local contracted returner with the same result contract, so the result
|
||||
contract is passed through Racket's contract machinery.
|
||||
|
||||
The contract must be written inline as a parenthesized contract form. The
|
||||
last element is used as the early-return result contract.
|
||||
|
||||
@racketblock[
|
||||
(define/contract/return (h x)
|
||||
(-> number? (or/c symbol? number?))
|
||||
(when (< x 0) (return 'x-not-positive))
|
||||
(let ((y (* x x)))
|
||||
(when (> y 100) (return 'maxed-out))
|
||||
(when (= y 9) (return "Wrong answer!"))
|
||||
y))
|
||||
]
|
||||
|
||||
Here the result contract is @racket[(or/c symbol? number?)]. The symbol
|
||||
returns are accepted, ordinary numeric results are accepted, and the string
|
||||
@racket["Wrong answer!"] is rejected.
|
||||
|
||||
@codeblock|{
|
||||
(h -1) ; => 'x-not-positive
|
||||
(h 2) ; => 4
|
||||
(h 11) ; => 'maxed-out
|
||||
(h 3) ; contract violation: string result
|
||||
}|
|
||||
|
||||
A zero-argument function works in the same way:
|
||||
|
||||
@racketblock[
|
||||
(define/contract/return (z)
|
||||
(-> symbol?)
|
||||
(let ((cs (current-seconds)))
|
||||
(when (= (remainder cs 3) 0) (return "deelbaar door 3"))
|
||||
(when (= (remainder cs 2) 0) (return 'dividable-by-2))
|
||||
'yes))
|
||||
]
|
||||
|
||||
The result contract is @racket[symbol?]. Returning
|
||||
@racket['dividable-by-2] or @racket['yes] is accepted. Returning the string
|
||||
@racket["deelbaar door 3"] is rejected.
|
||||
|
||||
Rest arguments can be used when the corresponding contract form is accepted
|
||||
by @racket[define/contract]:
|
||||
|
||||
@racketblock[
|
||||
(define/contract/return (sum . xs)
|
||||
(->* () #:rest (listof number?) number?)
|
||||
(when (null? xs) (return 0))
|
||||
(apply + xs))
|
||||
]
|
||||
|
||||
@codeblock|{
|
||||
(sum) ; => 0
|
||||
(sum 1 2) ; => 3
|
||||
(sum 1 'x) ; contract violation
|
||||
}|
|
||||
|
||||
The second form defines a contracted value. The value expression may use
|
||||
@racket[return], and the returned value is checked against
|
||||
@racket[result-contract].
|
||||
|
||||
@racketblock[
|
||||
(define/contract/return v
|
||||
number?
|
||||
(return 'ss))
|
||||
]
|
||||
|
||||
This definition raises a contract violation, because @racket['ss] does not
|
||||
satisfy @racket[number?].
|
||||
|
||||
}
|
||||
See @acketmodname[define-return/contract].
|
||||
|
||||
@section{Notes}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user