WashNGo-2.12: WASH is a family of embedded domain specific languages (EDSL) for programming Web applications in Haskell. Contents Index

WASH.CGI.CGITypes

Description

Types of outputable data.

Synopsis

newtype URL = URL { unURL :: String } data FileReference = FileReference { fileReferenceName :: FilePath fileReferenceContentType :: String fileReferenceExternalName :: String } data ResponseFileReference = ResponseFileReference FilePath data Status = Status { statusCode :: Int statusReason :: String statusContent :: (Maybe (WithHTML () IO ())) } newtype Location = Location URL data FreeForm = FreeForm { ffName :: String ffContentType :: String ffRawContents :: String } data CGIOption = NoPort | AutoPort | Port Int | NoHttps | AutoHttps | FullURL | PartialURL | SessionMode { unSessionMode :: SessionMode } type CGIOptions = [CGIOption] data SessionMode = LogOnly | StateIDOnly | LogAndState sessionNeedsLog :: SessionMode -> Bool sessionNeedsState :: SessionMode -> Bool

Documentation

newtype URL

Constructors URL unURL :: String Instances Read URL Reason URL Show URL

data FileReference

Constructors FileReference fileReferenceName :: FilePath valid local filename where this file can be accessed fileReferenceContentType :: String fileReferenceExternalName :: String Instances CGIOutput FileReference Read FileReference Reason FileReference Show FileReference

data ResponseFileReference

Assumes that file contains correctly formatted HTTP Response starting with Content-Type. Used internally to implement frames. Constructors ResponseFileReference FilePath Instances CGIOutput ResponseFileReference

data Status

Constructors Status statusCode :: Int status code statusReason :: String reason phrase statusContent :: (Maybe (WithHTML () IO ())) more explanation Instances CGIOutput Status

newtype Location

Constructors Location URL redirection Instances CGIOutput Location

data FreeForm

Constructors FreeForm ffName :: String internal name ffContentType :: String MIME type ffRawContents :: String contents as octet stream Instances CGIOutput FreeForm

data CGIOption

Constructors NoPort do not include port number in generated URLs AutoPort include automatically generated port number in generated URLs (default) Port Int use this port number in generated URLs NoHttps do not attempt to detect Https AutoHttps autodetect Https by checking for port number 443 and env var HTTPS (default) FullURL generate full URL including scheme, host, and port PartialURL generate absolute path URL, only (default) SessionMode unSessionMode :: SessionMode Instances Eq CGIOption Show CGIOption

type CGIOptions = [CGIOption]

data SessionMode

Constructors LogOnly generate log in hidden field, full server replay (default) StateIDOnly generate state id, server threads without replay (only with WSP) LogAndState log and state id, server threads with replay as fallback (only with WSP) Instances Bounded SessionMode Enum SessionMode Eq SessionMode Read SessionMode Show SessionMode

sessionNeedsLog :: SessionMode -> Bool

sessionNeedsState :: SessionMode -> Bool

Produced by Haddock version 0.8