1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-30 03:40:34 +02:00

Document and export `declare-opaque-header!'

* module/web/http.scm (declare-opaque-header!): Add docstring. New export.
* doc/ref/web.texi (HTTP): Add documentation.
This commit is contained in:
Ian Price 2012-05-08 00:18:59 +01:00 committed by Andy Wingo
parent 312e79f8d5
commit 64ead01db7
2 changed files with 8 additions and 0 deletions

View file

@ -398,6 +398,11 @@ HTTP stack like this:
(display (inet-ntoa ip) port))) (display (inet-ntoa ip) port)))
@end example @end example
@deffn {Scheme Procedure} declare-opaque-header! name
A specialised version of @code{declare-header!} for the case in which
you want a header's value to be returned/written ``as-is''.
@end deffn
@deffn {Scheme Procedure} valid-header? sym val @deffn {Scheme Procedure} valid-header? sym val
Return a true value iff @var{val} is a valid Scheme value for the header Return a true value iff @var{val} is a valid Scheme value for the header
with name @var{sym}. with name @var{sym}.

View file

@ -42,6 +42,7 @@
header->string header->string
declare-header! declare-header!
declare-opaque-header!
known-header? known-header?
header-parser header-parser
header-validator header-validator
@ -1145,6 +1146,8 @@ phrase\"."
;; emacs: (put 'declare-header! 'scheme-indent-function 1) ;; emacs: (put 'declare-header! 'scheme-indent-function 1)
;; emacs: (put 'declare-opaque!-header 'scheme-indent-function 1) ;; emacs: (put 'declare-opaque!-header 'scheme-indent-function 1)
(define (declare-opaque-header! name) (define (declare-opaque-header! name)
"Declares a given header as \"opaque\", meaning that its value is not
treated specially, and is just returned as a plain string."
(declare-header! name (declare-header! name
parse-opaque-string validate-opaque-string write-opaque-string)) parse-opaque-string validate-opaque-string write-opaque-string))