| Safe Haskell | None |
|---|
FP.API.Runner
- data RunnerException = RunnerException Text
- fromString :: String -> Text
- toString :: Text -> String
- decodeBytes :: ByteString -> Text
- encodeBytes :: Text -> ByteString
- data Filters = Filters {
- filtersRoot :: Text
- filtersBlacklist :: [Text]
- newtype ByteString64 = ByteString64 {}
- newtype WrappedUTCTime = WrappedUTCTime {
- unWrappedUTCTime :: UTCTime
- toPicoSeconds :: UTCTime -> Integer
- fromPicoSeconds :: Integer -> UTCTime
- newtype ProjectId = ProjectId {
- unProjectId :: Int
- unProjectIdString :: ProjectId -> String
- unProjectIdText :: ProjectId -> Text
- newtype RunConfigId = RunConfigId {
- unRunConfigId :: Int
- newtype JobId = JobId {}
- newtype CompileId = CompileId {
- unCompileId :: Int
- newtype ProcId = ProcId {}
- newtype GitShellId = GitShellId {
- unGitShellId :: Int
- newtype FormattedTime = FormattedTime {}
- newtype ModuleName = ModuleName {
- unModuleName :: Text
- moduleNameString :: ModuleName -> String
- data ModuleStatus
- newtype FileName = FileName {}
- unFileNameText :: FileName -> Text
- unFileNameString :: FileName -> String
- fileNameFromText :: Text -> FileName
- fileNameFromString :: String -> FileName
- data EncFileName
- = EncFileNameText { }
- | EncFileNameBase64 { }
- encodeBase64FileName :: FileName -> Text
- decodeBase64FileName :: Text -> FileName
- encFileName :: FileName -> EncFileName
- unEncFileName :: EncFileName -> FileName
- encFileNameFromByteString :: ByteString -> EncFileName
- encFileNameFromText :: Text -> EncFileName
- encFileNameFromString :: String -> EncFileName
- unEncFileNameString :: EncFileName -> String
- data FileType
- = SourceFile
- | DataFile
- data FileDesc = FileDesc {}
- data FileUpdate
- data TargetUpdate
- data UpdateActions = UpdateActions {
- _uaUpdates :: [(EncFileName, FileUpdate)]
- _uaNewTarget :: Maybe TargetUpdate
- data CompileDesc = CompileDesc {}
- data CompileIdent = CompileIdent {}
- newtype SessionId = SessionId Text
- newtype MailboxId = MailboxId Text
- data NewFileInfo = NewFileInfo {
- fiPath :: Text
- fiModule :: Maybe ModuleName
- data RenameType
- data RenameFileOutput
- data SaveFileOutput = SaveFileOutput FayTutorialToken (Maybe CompileDesc)
- data FayFileContent = FayFileContent {}
- type FayTutorialToken = TutorialConcurrentToken
- newtype TutorialConcurrentToken = TutorialConcurrentToken' {}
- incrToken :: TutorialConcurrentToken -> TutorialConcurrentToken
- data TypeInfo = TypeInfo SourceSpan Text [Text]
- data SourceSpan = SourceSpan {}
- data EitherSpan
- jobStillRunningTimeoutSeconds :: Int
- data ProjectMessagesOutput = ProjectMessagesOutput {}
- newtype StatusHash = StatusHash {
- unStatusHash :: Text
- data CompileResult
- = CRCanceled
- | CRSuccess
- | CRFailure
- | CRException Text
- data ProcessResult
- displayProcessResult :: ProcessResult -> Text
- data GitShellOutput
- data RunnerMessage
- = ProjectMessage LogLevel Text
- | ProcessOutput ProcId Text
- | ProcessStopped ProcId ProcessResult
- | GitShellOutput GitShellId GitShellOutput
- | CompileComplete CompileId CompileResult
- | ProjectHasOpened SessionId
- | ProjectHasClosed SessionId Bool Text
- | IdeCommandOutput JobId Text
- | JobException JobId Text
- | JobStillRunning JobId
- data LogLevel
- = LevelDebug
- | LevelInfo
- | LevelWarn
- | LevelError
- | LevelOther Text
- data SdistTarballInfo = SdistTarballInfo {
- stiPackageName :: !Text
- stiVersion :: !Text
- data GitHistoryItem = GitHistoryItem {}
- data GitRepositoryStatus
- data ProjectStatusSnapshot = ProjectStatusSnapshot {}
- data IdInfo
- data DefinitionSource
- definitionIdName :: DefinitionSource -> Text
- data ModuleId = ModuleId (Maybe EncFileName) ModuleName PackageId
- data AutoCompleteInput = AutoCompleteInput {}
- data PackageId = PackageId {}
- data SearchResult = SearchResult SourceSpan [Either Text Text]
- data HoogleResult = HoogleResult {
- hrURL :: String
- hrSources :: [(PackageLink, [ModuleLink])]
- hrTitle :: String
- hrBody :: String
- data PackageLink = PackageLink {}
- data ModuleLink = ModuleLink {}
- data RunnerOpeningStatus
- data RunnerCompileStatus
- data SourceInfo = SourceInfo {
- infoKind :: SourceInfoKind
- infoSpan :: EitherSpan
- infoMsg :: [(InfoChunkTag, Text)]
- data SourceInfoKind
- = SIKError
- | SIKWarning
- | SIKMismatch
- | SIKHint
- data InfoChunkTag
- = ICTPlain
- | ICTModule
- | ICTCode
- | ICTRefactor Text [(SourceSpan, Text)]
- | ICTCollapse
- | ICTOriginal
- data ProcessStatusSnapshot
- data RunnerPictureStatus = RunnerPictureStatus [PictureStatus]
- data PictureStatus = PictureStatus {
- pictureName :: Text
- pictureUrl :: Text
- pictureHash :: Text
- data RunnerBuildStatus
- data UploadedBuild = UploadedBuild {}
- data Progress = Progress {}
- newtype Approot = Approot {}
- newtype VirtualHost = VirtualHost {}
- approotString :: Approot -> String
- data ApprootPid = ApprootPid Approot ProcId
- newtype Port = Port {}
- data ErrorsAnd x = ErrorsAnd [String] (Maybe (Automatic x))
- data ModuleIncluded
- fileDescToModuleIncluded :: FileDesc -> ModuleIncluded
- data MergeModifyKind
- = Modified
- | Added
- | Deleted
- | TypeChanged
- data MergeModifyPair = MergeModifyPair MergeModifyKind MergeModifyKind
- newtype BlobSHA = BlobSHA {}
- newtype CommitSHA = CommitSHA {
- unCommitSHA :: Text
- newtype BranchName = BranchName {
- unBranchName :: Text
- branchToRef :: BranchName -> Text
- branchFromRef :: Text -> BranchName
- isMergeBranch :: BranchName -> Bool
- mergeBranch :: BranchName -> BranchName
- mergeBranchOrigin :: BranchName -> Maybe BranchName
- data CommitName
Documentation
data RunnerException Source
Constructors
| RunnerException Text |
fromString :: String -> TextSource
decodeBytes :: ByteString -> TextSource
encodeBytes :: Text -> ByteStringSource
Constructors
| Filters | |
Fields
| |
newtype ByteString64 Source
The standard ByteString instances in aeson are broken: they assume UTF8 encoding. This type instead uses base64 for proper round-tripping.
Constructors
| ByteString64 | |
Fields | |
newtype WrappedUTCTime Source
Constructors
| WrappedUTCTime | |
Fields
| |
toPicoSeconds :: UTCTime -> IntegerSource
fromPicoSeconds :: Integer -> UTCTimeSource
Constructors
| ProjectId | |
Fields
| |
Instances
newtype RunConfigId Source
Constructors
| RunConfigId | |
Fields
| |
Instances
Constructors
| CompileId | |
Fields
| |
Instances
newtype GitShellId Source
Constructors
| GitShellId | |
Fields
| |
Instances
newtype FormattedTime Source
Constructors
| FormattedTime | |
Fields | |
newtype ModuleName Source
Constructors
| ModuleName | |
Fields
| |
data ModuleStatus Source
Constructors
| WrongExtension | |
| NotTextual | |
| CFile | |
| BootFile ModuleName | |
| HeaderFilenameMismatch ModuleName | |
| ModuleOk ModuleName | This can also be valid for data files, if the user has manually excluded them. |
Constructors
| FileName | |
Fields | |
unFileNameText :: FileName -> TextSource
data EncFileName Source
Constructors
| EncFileNameText | |
Fields | |
| EncFileNameBase64 | |
Fields | |
Constructors
| SourceFile | |
| DataFile |
Constructors
| FileDesc | |
Fields | |
data FileUpdate Source
When a file in the project representation is changed by a ProjectUpdate
request, it often results in a change reflected in what we know about the
file. This change is reported in the UpdateActions structure using
this FileUpdate type.
Constructors
| FileUpdated FileDesc | |
| FileRemoved Bool |
data TargetUpdate Source
A project's target is a single module containing a function named main.
This type reflects if any change in the current target has been made.
Constructors
| TargetSet EncFileName | |
| TargetCleared |
data UpdateActions Source
After a ProjectUpdate request is processed, a set of UpdateActions
will result to reflect what changes have been made to the project
representation (and subsequently, what changes may need to be reflected
in the ide-backend, the database, and other caches).
Constructors
| UpdateActions | |
Fields
| |
data CompileDesc Source
Describe a compilation which has been accepted by the isolation-runner. This includes sufficient information to tell what is in the compilation, and to distinguish it from any other compilation.
Constructors
| CompileDesc | |
Fields | |
data CompileIdent Source
Constructors
| CompileIdent | |
Backend session ID.
data NewFileInfo Source
Constructors
| NewFileInfo | |
Fields
| |
data RenameType Source
Instances
data RenameFileOutput Source
Constructors
| RenameFileOutput (Maybe FayTutorialToken) (Maybe Text) (Maybe CompileDesc) | |
| WarnImportRenaming [EncFileName] |
data SaveFileOutput Source
Constructors
| SaveFileOutput FayTutorialToken (Maybe CompileDesc) |
data FayFileContent Source
Constructors
| FayFileContent | |
Fields | |
type FayTutorialToken = TutorialConcurrentTokenSource
A token for the tutorial.
newtype TutorialConcurrentToken Source
Token for a tutorial.
Constructors
| TutorialConcurrentToken' | |
Fields | |
Instances
Constructors
| TypeInfo SourceSpan Text [Text] |
data SourceSpan Source
Constructors
| SourceSpan | |
Fields
| |
data EitherSpan Source
Constructors
| ProperSpan SourceSpan | |
| TextSpan Text |
jobStillRunningTimeoutSeconds :: IntSource
The timing separation between JobStillRunning messages. Note
that the actual interval will always be larger than this due to
network overhead, etc.
data ProjectMessagesOutput Source
Constructors
| ProjectMessagesOutput | |
Fields
| |
Instances
newtype StatusHash Source
Constructors
| StatusHash | |
Fields
| |
data CompileResult Source
Constructors
| CRCanceled | |
| CRSuccess | |
| CRFailure | |
| CRException Text |
data ProcessResult Source
data GitShellOutput Source
data RunnerMessage Source
Constructors
| ProjectMessage LogLevel Text | |
| ProcessOutput ProcId Text | |
| ProcessStopped ProcId ProcessResult | |
| GitShellOutput GitShellId GitShellOutput | |
| CompileComplete CompileId CompileResult | |
| ProjectHasOpened SessionId | |
| ProjectHasClosed SessionId Bool Text | If the Bool is True, it indicates that the client should resume polling for project messages from a newly created project. If False, there is some more severe problem initiating the project, and the client should let the user know that the project may require manual recovery. |
| IdeCommandOutput JobId Text | FIXME At some point in the future, it would be nice to replace the second Text with a Value, to make it clear that we're encoding arbitrary JSON values. This is semantically more correct, and more efficient, but requires changes to the Fay encode/decode code, and therefore is not trivial to implement. |
| JobException JobId Text | |
| JobStillRunning JobId | Indicates to the client that a job is still being actively worked on. |
Constructors
| LevelDebug | |
| LevelInfo | |
| LevelWarn | |
| LevelError | |
| LevelOther Text |
data SdistTarballInfo Source
Constructors
| SdistTarballInfo | |
Fields
| |
data GitHistoryItem Source
Constructors
| GitHistoryItem | |
data GitRepositoryStatus Source
Instances
data ProjectStatusSnapshot Source
Constructors
| ProjectStatusSnapshot | |
Fields | |
Instances
data DefinitionSource Source
Constructors
| ModuleId (Maybe EncFileName) ModuleName PackageId |
data AutoCompleteInput Source
Constructors
| AutoCompleteInput | |
Fields
| |
Instances
Constructors
| PackageId | |
Fields
| |
data SearchResult Source
Constructors
| SearchResult SourceSpan [Either Text Text] |
data HoogleResult Source
Constructors
| HoogleResult | |
Fields
| |
data PackageLink Source
Constructors
| PackageLink | |
data ModuleLink Source
Constructors
| ModuleLink | |
data RunnerOpeningStatus Source
Constructors
| RunnerProjectOpening Text | |
| RunnerProjectOpen |
Instances
data RunnerCompileStatus Source
Constructors
| RunnerNotCompiling | |
| RunnerCompiling CompileIdent Progress | |
| RunnerCompileDone CompileIdent [SourceInfo] |
Instances
data SourceInfo Source
An error or warning in a source module.
Most errors are associated with a span of text, but some have only a location point.
Constructors
| SourceInfo | |
Fields
| |
data SourceInfoKind Source
Severity of a piece of info.
Constructors
| SIKError | |
| SIKWarning | |
| SIKMismatch | |
| SIKHint |
data InfoChunkTag Source
Constructors
| ICTPlain | |
| ICTModule | |
| ICTCode | Note: Ideally we'd distinguish identifiers, types, exprs, etc |
| ICTRefactor Text [(SourceSpan, Text)] | The |
| ICTCollapse | |
| ICTOriginal |
data ProcessStatusSnapshot Source
Constructors
| SnapshotNoProcess | |
| SnapshotProcessRunning ProcId (Maybe Text) | URL to visit project |
Instances
data RunnerPictureStatus Source
Status for the pictures directory.
Constructors
| RunnerPictureStatus [PictureStatus] |
Instances
data PictureStatus Source
Status of a picture.
Constructors
| PictureStatus | |
Fields
| |
data RunnerBuildStatus Source
Constructors
| RunnerNotBuilding | |
| RunnerBuilding Progress | |
| RunnerUploading |
Instances
data UploadedBuild Source
Constructors
| UploadedBuild | |
This type represents intermediate progress information during compilation.
Constructors
| Progress | |
Fields
| |
newtype VirtualHost Source
Constructors
| VirtualHost | |
Fields | |
approotString :: Approot -> StringSource
data ModuleIncluded Source
data MergeModifyKind Source
Constructors
| Modified | |
| Added | |
| Deleted | |
| TypeChanged |
Instances
data MergeModifyPair Source
Constructors
| MergeModifyPair MergeModifyKind MergeModifyKind |
Instances
A Git blob SHA in textual form.
A Git commit SHA in textual form.
Constructors
| CommitSHA | |
Fields
| |
Instances
newtype BranchName Source
A Git branch name, such as master, or merge/master.
Constructors
| BranchName | |
Fields
| |
branchToRef :: BranchName -> TextSource
data CommitName Source
A reference to a specific commit, which can be done by several different means.
Constructors
| CommitByBranch BranchName | |
| CommitBySHA CommitSHA |