doc/reference/blueboxes.rktd

2 …lazy-require.rkt") (q 248070 . 4) (q lib "racket/runtime-path.rkt") (q 294125 . 5) (q 400457 . 40)…
692 (lazy-require [module-path (fun-import ...)] ...)
697 (lazy-require-syntax [module-path (macro-import ...)] ...)
886 (max x ...+) -> real?
1034 (random min max [rand-gen]) -> exact-nonnegative-integer?
1036   max : (integer-in (+ 1 min) (+ 4294967087 min))
1071 (crypto-random-bytes n) -> bytes?
1116 (integer-bytes->integer  bstr
1121   bstr : bytes?
1125   end : exact-nonnegative-integer? = (bytes-length bstr)
1127 (integer->integer-bytes  n
1132                          start])     -> bytes?
1137   dest-bstr : (and/c bytes? (not/c immutable?))
1138             = (make-bytes size-n)
1141 (floating-point-bytes->real  bstr
1145   bstr : bytes?
1148   end : exact-nonnegative-integer? = (bytes-length bstr)
1150 (real->floating-point-bytes  x
1154                              start])     -> bytes?
1158   dest-bstr : (and/c bytes? (not/c immutable?))
1159             = (make-bytes size-n)
1718 (floating-point-bytes->extfl  bstr
1722   bstr : bytes?
1725   end : exact-nonnegative-integer? = (bytes-length bstr)
1727 (extfl->floating-point-bytes  x
1730                               start])     -> bytes?
1733   dest-bstr : (and/c bytes? (not/c immutable?))
1734             = (make-bytes 10)
1966      #:max-width max-width
1977   max-width : (or/c exact-nonnegative-integer? +inf.0)
1991      #:max-width max-width
2002   max-width : (or/c exact-nonnegative-integer? +inf.0)
2016      #:max-width max-width
2027   max-width : (or/c exact-nonnegative-integer? +inf.0)
2041      #:max-width max-width
2052   max-width : (or/c exact-nonnegative-integer? +inf.0)
2091       #:max-width max-width
2102   max-width : (or/c exact-nonnegative-integer? +inf.0)
2116       #:max-width max-width
2127   max-width : (or/c exact-nonnegative-integer? +inf.0)
2141       #:max-width max-width
2152   max-width : (or/c exact-nonnegative-integer? +inf.0)
2162 (bytes? v) -> boolean?
2165 (make-bytes k [b]) -> bytes?
2169 (bytes b ...) -> bytes?
2172 (bytes->immutable-bytes bstr) -> (and/c bytes? immutable?)
2173   bstr : bytes?
2178 (bytes-length bstr) -> exact-nonnegative-integer?
2179   bstr : bytes?
2181 (bytes-ref bstr k) -> byte?
2182   bstr : bytes?
2185 (bytes-set! bstr k b) -> void?
2186   bstr : (and/c bytes? (not/c immutable?))
2190 (subbytes bstr start [end]) -> bytes?
2191   bstr : bytes?
2193   end : exact-nonnegative-integer? = (bytes-length str)
2195 (bytes-copy bstr) -> bytes?
2196   bstr : bytes?
2198 (bytes-copy!  dest
2203   dest : (and/c bytes? (not/c immutable?))
2205   src : bytes?
2207   src-end : exact-nonnegative-integer? = (bytes-length src)
2209 (bytes-fill! dest b) -> void?
2210   dest : (and/c bytes? (not/c immutable?))
2213 (bytes-append bstr ...) -> bytes?
2214   bstr : bytes?
2216 (bytes->list bstr) -> (listof byte?)
2217   bstr : bytes?
2219 (list->bytes lst) -> bytes?
2222 (make-shared-bytes k [b]) -> bytes?
2226 (shared-bytes b ...) -> bytes?
2229 (bytes=? bstr1 bstr2 ...) -> boolean?
2230   bstr1 : bytes?
2231   bstr2 : bytes?
2233 (bytes<? bstr1 bstr2 ...) -> boolean?
2234   bstr1 : bytes?
2235   bstr2 : bytes?
2237 (bytes>? bstr1 bstr2 ...) -> boolean?
2238   bstr1 : bytes?
2239   bstr2 : bytes?
2241 (bytes->string/utf-8 bstr [err-char start end]) -> string?
2242   bstr : bytes?
2245   end : exact-nonnegative-integer? = (bytes-length bstr)
2247 (bytes->string/locale  bstr
2251   bstr : bytes?
2254   end : exact-nonnegative-integer? = (bytes-length bstr)
2256 (bytes->string/latin-1  bstr
2260   bstr : bytes?
2263   end : exact-nonnegative-integer? = (bytes-length bstr)
2265 (string->bytes/utf-8 str [err-byte start end]) -> bytes?
2271 (string->bytes/locale str [err-byte start end]) -> bytes?
2277 (string->bytes/latin-1  str
2280                         end])    -> bytes?
2291 (bytes-utf-8-length bstr [err-char start end])
2293   bstr : bytes?
2296   end : exact-nonnegative-integer? = (bytes-length bstr)
2298 (bytes-utf-8-ref bstr [skip err-char start end]) -> (or/c char? #f)
2299   bstr : bytes?
2303   end : exact-nonnegative-integer? = (bytes-length bstr)
2305 (bytes-utf-8-index  bstr
2311   bstr : bytes?
2315   end : exact-nonnegative-integer? = (bytes-length bstr)
2317 (bytes-open-converter from-name to-name)
2318  -> (or/c bytes-converter? #f)
2322 (bytes-close-converter converter) -> void
2323   converter : bytes-converter?
2325 (bytes-convert  converter
2332  -> (or/c bytes? exact-nonnegative-integer?)
2335   converter : bytes-converter?
2336   src-bstr : bytes?
2339               = (bytes-length src-bstr)
2340   dest-bstr : (or/c bytes? #f) = #f
2344                       (bytes-length dest-bstr))
2346 (bytes-convert-end  converter
2350  -> (or/c bytes? exact-nonnegative-integer?)
2352   converter : bytes-converter?
2353   dest-bstr : (or/c bytes? #f) = #f
2357                       (bytes-length dest-bstr))
2359 (bytes-converter? v) -> boolean?
2364 (bytes-append* str ... strs) -> bytes?
2365   str : bytes?
2366   strs : (listof bytes?)
2368 (bytes-join strs sep) -> bytes?
2369   strs : (listof bytes?)
2370   sep : bytes?
2535   bstr : bytes?
2537   bstr : bytes?
2538   handler : (or/c #f (bytes? -> any))
2541   bstr : bytes?
2543   bstr : bytes?
2544   handler : (or/c #f (bytes? -> any))
2549 (regexp-quote bstr [case-sensitive?]) -> bytes?
2550   bstr : bytes?
2553 (regexp-max-lookbehind pattern) -> exact-nonnegative-integer?
2565         (or/c #f (cons/c bytes?  (listof (or/c bytes?  #f)))))
2566   pattern : (or/c string? bytes? regexp? byte-regexp?)
2567   input : (or/c string? bytes? path? input-port?)
2571   input-prefix : bytes? = #""
2583         (listof (or/c bytes? (listof (or/c #f bytes?)))))
2584   pattern : (or/c string? bytes? regexp? byte-regexp?)
2585   input : (or/c string? bytes? path? input-port?)
2588   input-prefix : bytes? = #""
2599  -> (or/c #f (cons/c bytes? (listof (or/c bytes? #f))))
2600   pattern : (or/c string? bytes? regexp? byte-regexp?)
2605   input-prefix : bytes? = #""
2619   pattern : (or/c string? bytes? regexp? byte-regexp?)
2620   input : (or/c string? bytes? path? input-port?)
2624   input-prefix : bytes? = #""
2636   pattern : (or/c string? bytes? regexp? byte-regexp?)
2637   input : (or/c string? bytes? path? input-port?)
2640   input-prefix : bytes? = #""
2649   pattern : (or/c string? bytes? regexp? byte-regexp?)
2650   input : (or/c string? bytes? path? input-port?)
2654   input-prefix : bytes? = #""
2657   pattern : (or/c string? bytes? regexp? byte-regexp?)
2658   input : (or/c string? bytes? path?)
2666  -> (or/c (cons/c bytes? (listof (or/c bytes? #f)))
2668   pattern : (or/c string? bytes? regexp? byte-regexp?)
2673   input-prefix : bytes? = #""
2687   pattern : (or/c string? bytes? regexp? byte-regexp?)
2692   input-prefix : bytes? = #""
2700  -> (or/c (cons/c bytes? (listof (or/c bytes? #f)))
2702   pattern : (or/c string? bytes? regexp? byte-regexp?)
2707   input-prefix : bytes? = #""
2721   pattern : (or/c string? bytes? regexp? byte-regexp?)
2726   input-prefix : bytes? = #""
2738   pattern : (or/c string? bytes? regexp? byte-regexp?)
2742   input-prefix : bytes? = #""
2755         (or/c #f (cons/c bytes?  (listof (or/c bytes?  #f)))))
2756     (or/c #f bytes?)
2757   pattern : (or/c string? bytes? regexp? byte-regexp?)
2758   input : (or/c string? bytes? path? input-port?)
2762   input-prefix : bytes? = #""
2773     (or/c #f bytes?)
2774   pattern : (or/c string? bytes? regexp? byte-regexp?)
2775   input : (or/c string? bytes? path? input-port?)
2778   input-prefix : bytes? = #""
2794     (or/c #f bytes?)
2795   pattern : (or/c string? bytes? regexp? byte-regexp?)
2800   input-prefix : bytes? = #""
2816     (or/c #f bytes?)
2817   pattern : (or/c string? bytes? regexp? byte-regexp?)
2822   input-prefix : bytes? = #""
2833         (cons/c bytes? (listof bytes?)))
2834   pattern : (or/c string? bytes? regexp? byte-regexp?)
2835   input : (or/c string? bytes? input-port?)
2838   input-prefix : bytes? = #""
2847         bytes?)
2848   pattern : (or/c string? bytes? regexp? byte-regexp?)
2849   input : (or/c string? bytes?)
2850   insert : (or/c string? bytes?
2852                  ((bytes?) () #:rest (listof bytes?) . ->* . bytes?))
2853   input-prefix : bytes? = #""
2860                   input-prefix]) -> (or/c string? bytes?)
2861   pattern : (or/c string? bytes? regexp? byte-regexp?)
2862   input : (or/c string? bytes?)
2863   insert : (or/c string? bytes?
2865                  ((bytes?) () #:rest (listof bytes?) . ->* . bytes?))
2868   input-prefix : bytes? = #""
2870 (regexp-replaces input replacements) -> (or/c string? bytes?)
2871   input : (or/c string? bytes?)
2873                   (list/c (or/c string? bytes? regexp? byte-regexp?)
2874                           (or/c string? bytes?
2876                               ((bytes?) () #:rest (listof bytes?) . ->* . bytes?))))
2880 (regexp-replace-quote bstr) -> bytes?
2881   bstr : bytes?
3967 (in-bytes bstr [start stop step]) -> sequence?
3968   bstr : bytes?
3977 (in-input-port-bytes in) -> sequence?
3988 (in-bytes-lines [in mode]) -> sequence?
4279 (stream-lazy stream-expr)
4280 (stream-lazy #:who who-expr stream-expr)
4768         #:lazy? lazy?
4774   lazy? : any/c = (not (and (equal? kind 'immutable)
6419          field-spec = [field-name maybe-lazy contract-expr]
6421                                   maybe-lazy
6430          maybe-lazy =
6431                     | #:lazy
7880 (lazy body ...+)
9807 (open-input-bytes bstr [name]) -> (and/c input-port? string-port?)
9808   bstr : bytes?
9815 (open-output-bytes [name]) -> (and/c output-port? string-port?)
9821 (get-output-bytes  out
9824                    end-pos]) -> bytes?
9858              (bytes?
9865           (bytes? exact-nonnegative-integer? (or/c evt? #f)
9910                (bytes? exact-nonnegative-integer?
9928                    (bytes? exact-nonnegative-integer?
9963 (port->bytes [in #:close? close?]) -> bytes?
9975 (port->bytes-lines [in
9977                     #:close? close?])     -> (listof bytes?)
9993 (call-with-output-bytes proc) -> bytes?
9999 (with-output-to-bytes proc) -> bytes?
10006 (call-with-input-bytes bstr proc) -> any
10007   bstr : bytes?
10014 (with-input-from-bytes bstr proc) -> any
10015   bstr : bytes?
10036   read-in : (bytes?
10042                     (bytes? exact-nonnegative-integer?
10043                      (bytes? exact-nonnegative-integer?
10114                      [error-bytes
10121   error-bytes : (or/c #f bytes?) = #f
10130                       [error-bytes
10133                        newline-bytes
10137   error-bytes : (or/c #f bytes?) = #f
10140   newline-bytes : (or/c #f bytes?) = #f
10221   read-wrap : (bytes? (or/c exact-nonnegative-integer?
10230   peek-wrap : (bytes? exact-nonnegative-integer? (or/c evt? #f)
10245   proc : (procedure? bytes? . -> . (or/c exact-nonnegative-integer?
10254 (read-bytes-evt k in) -> evt?
10258 (read-bytes!-evt bstr in) -> evt?
10259   bstr : (and/c bytes? (not/c immutable?))
10262 (read-bytes-avail!-evt bstr in) -> evt?
10263   bstr : (and/c bytes? (not/c immutable?))
10279 (read-bytes-line-evt in [mode]) -> evt?
10284 (peek-bytes-evt k skip progress-evt in) -> evt?
10289 (peek-bytes!-evt bstr skip progress-evt in) -> evt?
10290   bstr : (and/c bytes? (not/c immutable?))
10294 (peek-bytes-avail!-evt bstr
10298   bstr : (and/c bytes? (not/c immutable?))
10314   pattern : (or/c string? bytes? regexp? byte-regexp?)
10341 (read-bytes-line [in mode]) -> (or/c bytes? eof-object?)
10350 (read-bytes amt [in]) -> (or/c bytes? eof-object?)
10361 (read-bytes! bstr [in start-pos end-pos])
10363   bstr : bytes?
10366   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10368 (read-bytes-avail! bstr [in start-pos end-pos])
10370   bstr : bytes?
10373   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10375 (read-bytes-avail!*  bstr
10380   bstr : bytes?
10383   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10385 (read-bytes-avail!/enable-break  bstr
10390   bstr : bytes?
10393   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10395 (peek-string amt skip-bytes-amt [in]) -> (or/c string? eof-object?)
10397   skip-bytes-amt : exact-nonnegative-integer?
10400 (peek-bytes amt skip-bytes-amt [in]) -> (or/c bytes? eof-object?)
10402   skip-bytes-amt : exact-nonnegative-integer?
10406                skip-bytes-amt
10412   skip-bytes-amt : exact-nonnegative-integer?
10417 (peek-bytes!  bstr
10418               skip-bytes-amt
10423   bstr : (and/c bytes? (not/c immutable?))
10424   skip-bytes-amt : exact-nonnegative-integer?
10427   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10429 (peek-bytes-avail!  bstr
10430                     skip-bytes-amt
10436   bstr : (and/c bytes? (not/c immutable?))
10437   skip-bytes-amt : exact-nonnegative-integer?
10441   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10443 (peek-bytes-avail!*  bstr
10444                      skip-bytes-amt
10450   bstr : (and/c bytes? (not/c immutable?))
10451   skip-bytes-amt : exact-nonnegative-integer?
10455   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10457 (peek-bytes-avail!/enable-break  bstr
10458                                  skip-bytes-amt
10464   bstr : (and/c bytes? (not/c immutable?))
10465   skip-bytes-amt : exact-nonnegative-integer?
10469   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10487 (peek-char [in skip-bytes-amt]) -> (or/c char? eof-object?)
10489   skip-bytes-amt : exact-nonnegative-integer? = 0
10491 (peek-byte [in skip-bytes-amt]) -> (or/c byte? eof-object?)
10493   skip-bytes-amt : exact-nonnegative-integer? = 0
10496                        skip-bytes-amt
10501   skip-bytes-amt : exact-nonnegative-integer? = 0
10506                        skip-bytes-amt
10512   skip-bytes-amt : exact-nonnegative-integer? = 0
10560 (write-bytes bstr [out start-pos end-pos])
10562   bstr : bytes?
10565   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10567 (write-bytes-avail  bstr
10571   bstr : bytes?
10574   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10576 (write-bytes-avail*  bstr
10581   bstr : bytes?
10584   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10586 (write-bytes-avail/enable-break  bstr
10591   bstr : bytes?
10594   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
10604 (write-bytes-avail-evt  bstr
10608   bstr : bytes?
10611   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
11138  -> (or/c (void) bytes?)
11150   in : (or/c input-port? bytes?)
11155 (sha1-bytes in [start end]) -> bytes?
11156   in : (or/c bytes? input-port?)
11160 (sha224-bytes in [start end]) -> bytes?
11161   in : (or/c bytes? input-port?)
11165 (sha256-bytes in [start end]) -> bytes?
11166   in : (or/c bytes? input-port?)
12212   module-decl : (or/c syntax? pair? path? input-port? string? bytes?)
12239                          string? bytes?
12245              string? bytes?
12253                           'bytes
12260              'bytes
12267                                 'bytes
12274              'bytes
12314                     (or/c byte-regexp? bytes? string? path?)))
12318                           (or/c byte-regexp? bytes? string? path?)))
12414   i/o : (or/c bytes? string? eof-object?)
12416 (get-output evaluator) -> (or/c #f input-port? bytes? string?)
12419  -> (or/c #f input-port? bytes? string?)
12694 (bytes->path bstr [type]) -> path?
12695   bstr : bytes?
12701 (path->bytes path) -> bytes?
12710 (bytes->path-element  bstr
12714   bstr : bytes?
12721 (path-element->bytes path) -> bytes?
12792   ext : (or/c string? bytes?)
12796   ext : (or/c string? bytes?)
12797   sep : (or/c string? bytes?) = #"_"
12801   ext : (or/c string? bytes?)
12805   ext : (or/c string? bytes?)
12814 (path-get-extension path) -> (or/c bytes? #f)
12817 (path-has-extension? path ext) -> (or/c bytes? #f)
12819   ext : (or/c bytes? string?)
12821 (filename-extension path) -> (or/c bytes? #f)
12867   str : (or/c string? bytes?)
13003 (file->bytes path [#:mode mode-flag]) -> bytes?
13024 (file->bytes-lines  path
13026                     #:line-mode line-mode]) -> (listof bytes?)
13174                                     #:max-delay max-delay])
13182   max-delay : real? = 0.2
13190                               #:max-delay max-delay]) -> any
13197   max-delay : (and/c real? (not/c negative?)) = 0.2
13224             [max-allow-wait
13228   max-allow-wait : exact-nonnegative-integer? = 4
13316   bstr : bytes?
13318   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13322   bstr : bytes?
13324   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13335   bstr : bytes?
13337   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13341   bstr : bytes?
13343   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13354   bstr : bytes?
13356   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13363   bstr : bytes?
13365   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13374   bstr : (and/c bytes? (not immutable?))
13376   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13386   bstr : (and/c bytes? (not immutable?))
13388   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13398   bstr : (and/c bytes? (not immutable?))
13400   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13434   bstr : bytes?
13436   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13443   bstr : bytes?
13445   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13452   bstr : (and/c bytes? (not immutable?))
13454   end-pos : exact-nonnegative-integer? = (bytes-length bstr)
13523   arg : (or/c path? string-no-nuls? bytes-no-nuls?)
13582   command : (or/c string-no-nuls? bytes-no-nuls?)
13587   arg : (or/c path? string-no-nuls? bytes-no-nuls?)
13600   command : (or/c string-no-nuls? bytes-no-nuls?)
13607   arg : (or/c path? string-no-nuls? bytes-no-nuls?)
13624   command : (or/c string-no-nuls? bytes-no-nuls?)
13631   arg : (or/c path? string-no-nuls? bytes-no-nuls?)
13650   command : (or/c path? string-no-nuls? bytes-no-nuls?)
13663   arg : (or/c path? string-no-nuls? bytes-no-nuls?)
13683 (bytes-no-nuls? x) -> boolean?
13731 (log-max-level logger [topic]) -> (or/c log-level/c #f)
13918 (bytes-environment-variable-name? v) -> boolean?
13923   name : bytes-environment-variable-name?
13924   val : bytes-no-nuls?
13927  -> (or/c #f (and/c bytes-no-nuls? immutable?))
13929   name : bytes-environment-variable-name?
13936   name : bytes-environment-variable-name?
13937   maybe-bstr : (or/c bytes-no-nuls? #f)
13942  -> (listof (and/c bytes-environment-variable-name? immutable?))
13959  -> (or/c symbol? string? bytes? exact-positive-integer? vector? #f)
14097 (phantom-bytes? v) -> boolean?
14100 (make-phantom-bytes k) -> phantom-bytes?
14103 (set-phantom-bytes! phantom-bstr k) -> phantom-bytes?
14104   phantom-bstr : phantom-bytes?
14446 (unsafe-bytes-length bstr) -> fixnum?
14447   bstr : bytes?
14449 (unsafe-bytes-ref bstr k) -> byte?
14450   bstr : bytes?
14453 (unsafe-bytes-set! bstr k b) -> void?
14454   bstr : (and/c bytes? (not/c immutable?))
14458 (unsafe-bytes-copy!  dest
14463   dest : (and/c bytes? (not/c immutable?))
14465   src : bytes?
14467   src-end : fixnum? = (bytes-length src)
14469 (unsafe-bytes->immutable-bytes! bstr)
14470  -> (and/c bytes? immutable?)
14471   bstr : bytes?