Add docs for "commands".Command.Run

To clarify that if you want to access the request body after writing need to use
multipart requests.

License: MIT
Signed-off-by: Jan Winkelmann <j-winkelmann@tuhh.de>
This commit is contained in:
Jan Winkelmann 2016-11-14 22:32:41 +01:00
parent d5c716a3f0
commit 1a3fa80fdb

View File

@ -52,9 +52,14 @@ type HelpText struct {
// Command is a runnable command, with input arguments and options (flags).
// It can also have Subcommands, to group units of work into sets.
type Command struct {
Options []Option
Arguments []Argument
PreRun func(req Request) error
Options []Option
Arguments []Argument
PreRun func(req Request) error
// Run is the function that processes the request to generate a response.
// Note that when executing the command over the HTTP API you can only read
// after writing when using multipart requests. The request body will not be
// available for reading after the HTTP connection has been written to.
Run Function
PostRun Function
Marshalers map[EncodingType]Marshaler