Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.ONCRPC.XDR.Generate

Description

Generate Haskell code from XDR descriptions as per RFC4506 and RPC extensions from RFC5531

Synopsis

generateFromFile :: GenerateOptions -> FilePath -> IO String
generate :: MonadFail m => GenerateOptions -> String -> ByteString -> m String
generateModule :: MonadFail m => GenerateOptions -> String -> ByteString -> m (Module ())
data ReidentOptions = ReidentOptions {
- reidentUpperPrefix, reidentLowerPrefix :: String
- reidentJoinField, reidentJoinProcedure :: Maybe String
}
data GenerateOptions = GenerateOptions {
- generateModuleName :: String
- generateReidentOptions :: ReidentOptions
}
defaultReidentOptions :: ReidentOptions

Documentation

generateFromFile :: GenerateOptions -> FilePath -> IO String Source #

generate from a file.

generate :: MonadFail m => GenerateOptions -> String -> ByteString -> m String Source #

Parse an XDR specification and generate pretty-printed Haskell source string, or fail on error. The String argument provides a description of the input to use in parse errors.

generateModule :: MonadFail m => GenerateOptions -> String -> ByteString -> m (Module ()) Source #

Parse an XDR specification and generate a Haskell module, or fail on error. The String argument provides a description of the input to use in parse errors.

data ReidentOptions Source #

How to generate Haskell identifiers from XDR in order to confirm to Haskell's lexical rules and ensure uniqueness.

Constructors

ReidentOptions

Fields

reidentUpperPrefix, reidentLowerPrefix :: String
Prefix to use to make an identifier a different case if necessary, e.g. "_" for lower-case, or "XDR_" for upper case (default empty: just changes the first character, possibly resulting in names like "nFS_NULL")
reidentJoinField, reidentJoinProcedure :: Maybe String
Prefix fields with their type name (or program, version name) and this string (necessary for most XDR files), or Nothing to use only the field name (or procedure name), which assumes uniqueness across the file (e.g., if you wrote the file yourself, though often safe for procedures only) (default Just "'")

Instances

Instances details

Show ReidentOptions Source #
Instance details Defined in Network.ONCRPC.XDR.Reident Methods showsPrec :: Int -> ReidentOptions -> ShowS # show :: ReidentOptions -> String # showList :: [ReidentOptions] -> ShowS #
Eq ReidentOptions Source #
Instance details Defined in Network.ONCRPC.XDR.Reident Methods (==) :: ReidentOptions -> ReidentOptions -> Bool # (/=) :: ReidentOptions -> ReidentOptions -> Bool #

data GenerateOptions Source #

Options for generating Haskell code

Constructors

GenerateOptions
Fields generateModuleName :: String Name for the generated module generateReidentOptions :: ReidentOptions

Instances

Instances details

Show GenerateOptions Source #
Instance details Defined in Network.ONCRPC.XDR.Generate Methods showsPrec :: Int -> GenerateOptions -> ShowS # show :: GenerateOptions -> String # showList :: [GenerateOptions] -> ShowS #
Eq GenerateOptions Source #
Instance details Defined in Network.ONCRPC.XDR.Generate Methods (==) :: GenerateOptions -> GenerateOptions -> Bool # (/=) :: GenerateOptions -> GenerateOptions -> Bool #

defaultReidentOptions :: ReidentOptions Source #