| Safe Haskell | None |
|---|
FP.API.Types
- data ProjectState
- = Workspaces
- | UserState
- type Returns' a = Returns (CanFail a)
- data CanFail a
- newtype CanFailT m a = CanFailT {
- runCanFailT :: m (CanFail a)
- type MonadFail m = MonadIO m
- failure :: MonadFail m => Text -> m a
- mapCanFailT :: (m (CanFail a) -> n (CanFail b)) -> CanFailT m a -> CanFailT n b
- eitherFail :: MonadFail m => m (Either Text a) -> m a
- eitherToCanFail :: Show e => Either e a -> CanFail a
- tryOrFail :: (MonadBaseControl IO m, MonadFail m) => m a -> m (CanFail a)
- maybeFail :: MonadFail m => Text -> m (Maybe a) -> m a
- data RunnerProjectClosed = RunnerProjectClosed (Maybe SessionId)
- data GetProjectMessages = GetProjectMessages ProjectMessagesRequest (Returns' ProjectMessagesOutput)
- data ProjectMessagesRequest
- data IdeCommand
- = GetInitialProjectInfo Text (Returns' InitialProjectInfo)
- | ReparseProjectSettings (Returns' (Maybe RunnerProjectClosed))
- | SetSettings SetSettingsInput (Returns' (Either CompileIdent RunnerProjectClosed))
- | SetPublic Bool (Returns' ())
- | GetPublic (Returns' Bool)
- | SetProjectMetadata Text Text (Returns' ())
- | SaveProjectState ProjectState Text (Returns' ())
- | DeleteProject Text (Returns' ())
- | ResetProjectSettings Text (Returns' RunnerProjectClosed)
- | SdistTarball (Returns' (Either Text SdistTarballInfo))
- | RestartBackend Text (Returns' RunnerProjectClosed)
- | GenerateHaddocks (Returns' Text)
- | Ping (Returns' ())
- | AddFile NewFileInfo (Returns' SaveFileOutput)
- | SaveFile EncFileName Text FayTutorialToken (Returns' SaveFileOutput)
- | DeleteFile EncFileName (Returns' (Maybe CompileDesc))
- | RenameFile EncFileName NewFileInfo RenameType (Returns' RenameFileOutput)
- | GetFile EncFileName (Returns' FayFileContent)
- | GetFileToken EncFileName (Returns' FayTutorialToken)
- | GetAllFiles (Returns' [FileDesc])
- | SetModuleExclusion EncFileName Bool (Returns' (Maybe CompileDesc))
- | ReformatModule EncFileName (Returns' (Maybe CompileDesc))
- | RenderFileMarkdown EncFileName (Returns' HtmlReply)
- | GetTypeInfo SourceSpan (Returns' (Maybe TypeInfo))
- | GetTypeInfoDominators SourceSpan (Returns' [TypeInfo])
- | GetFindUsages SourceSpan (Returns' [SearchResult])
- | GetDefinitionSource SourceSpan (Returns' IdInfo)
- | GetAutocompletions AutoCompleteInput (Returns' [Text])
- | IdeHoogleSearch (Maybe EncFileName) Bool Int Int Int Text (Returns' (Text, [HoogleResult], Maybe Int))
- | SearchProject SearchQuery Int Int Bool (Returns' [SearchResult])
- | SetTarget (Maybe (Either EncFileName RunConfigId)) (Returns' (Maybe CompileDesc))
- | GetTarget (Returns' (Maybe (Either EncFileName RunConfigId)))
- | RunTarget Bool (Returns' ProcId)
- | CompileBinary EncFileName [(Text, Text)] (Returns' UploadedBuild)
- | GetGitHistory Int Int (Returns' [GitHistoryItem])
- | IsProjectDirty (Returns' Bool)
- | SetRoot Text Text (Returns' CompileDesc)
- | SetRemotes RemotesList (Returns' ())
- | GetGitConfig Text (Returns' Text)
- | SetGitConfig Text Text (Returns' ())
- | GitCommit Text (Returns' CommitSHA)
- | GitReset (Returns' RunnerProjectClosed)
- | GitPush Text (Returns' GitPushResult)
- | GitPushIgnoreDirty Text (Returns' ())
- | GitPull Text (Returns' GitPullResult)
- | GitMergeAbort (Returns' RunnerProjectClosed)
- | GitMergeDone MaybeText (Returns' GitResolvedResult)
- | GitResolveFile EncFileName (Returns' ())
- | GitDiff (Returns' Text)
- | StartGitShell (Returns' GitShellId)
- | GitShellInput GitShellId Text (Returns' ())
- | ApplyGitShell GitShellId (Returns' RunnerProjectClosed)
- | CancelGitShell GitShellId (Returns' ())
- | CreateBranch BranchName CommitName (Returns' ())
- | DeleteBranch BranchName (Returns' ())
- | CheckoutBranch BranchName (Returns' GitCheckoutResult)
- | RenameRefactoring SourceSpan Text RefactoringContext (Returns' RefactoringOutput)
- | ExtractRefactoring SourceSpan Text RefactoringContext (Returns' RefactoringOutput)
- | GetKeterYaml FayDeploymentId ModuleName (Returns' KeterYaml)
- | SetRunConfigs [(RunConfigId, RunConfig)] (Returns' ())
- | SetDeployments [(FayDeploymentId, Deployment)] (Returns' ())
- | GetNewRunConfig (Returns' NewRunConfig)
- | GetNewDeployment (Returns' NewDeployment)
- | GetNewWebApp FayDeploymentId (Returns' NewWebApp)
- | GetNewBgJob FayDeploymentId (Returns' NewBgJob)
- | CheckHostName Text (Returns' UseHostName)
- | GetRandomHostName (Returns' RandomHostName)
- | GetDeploymentManagerInfo (Returns' DeploymentManagerInfo)
- | PutStdin ProcId Text (Returns' Bool)
- | StopRunningCode (Returns' ())
- | StartInteractive [FileToRun] (Returns' (ErrorsAnd ProcId))
- | StartInteractiveWeb [FileToRun] (Returns' (ErrorsAnd ApprootPid))
- | HoogleSearch Bool Text Text (Returns' FayHoogleResults)
- | GetConflictingPackages (Returns' [[(Bool, Text)]])
- data FayCommand
- = UserAuthedGithub (Returns' Bool)
- | RevokeGithub (Returns' ())
- | GetGithubUrl Text (Returns' Text)
- | SshPublicKey (Returns' Text)
- | GenerateConfiguration (Returns' ())
- | GetIFilesFromCode Text Text (Maybe Text) (Returns' IFiles)
- | GetIFilesFromURL Text (Returns' IFiles)
- | SaveProfile Theme Int Bool (Returns' ())
- | GetProjectId Text (Returns' ProjectId)
- | CloseAllProjects (Returns' ())
- | SetSettingsSubstitutions Text (Returns' ())
- | GetSettingsSubstitutions (Returns' Text)
- | SeenAnnouncement Text (Returns' ())
- | GetAnnouncements (Returns' [(Text, Text, Text)])
- data InitialProjectInfo = InitialProjectInfo {
- ipiTitle :: Text
- ipiDesc :: Text
- ipiGitUrl :: Maybe Text
- ipiMergeConflicts :: Maybe [MergeConflict]
- ipiState :: [(ProjectState, Text)]
- ipiFiles :: [FileDesc]
- ipiTarget :: Maybe (Either EncFileName RunConfigId)
- ipiPublished :: Bool
- ipiBranches :: BranchesList
- ipiRemotes :: RemotesList
- ipiRunConfigs :: [(RunConfigId, RunConfig)]
- ipiDeployments :: [(FayDeploymentId, Deployment)]
- ipiTheme :: Theme
- ipiFontSize :: Int
- ipiSearchWithRegex :: Bool
- ipiLicense :: IdeLicense
- ipiCanPublish :: Bool
- ipiSettings :: Maybe ProjectSettings
- data IFiles = IFiles {
- ifilesFiles :: [IFile]
- ifilesCloneUrl :: Text
- data IFile = IFile {}
- data Base64 = Base64 Text
- data IFileContents
- = IFCText [IFileContent]
- | IFCBase64 Base64
- data IFileContent
- data Editable = Editable {}
- data SrcSpan = SrcSpan SrcLoc SrcLoc
- data SrcLoc = SrcLoc {
- srcLocLine :: Int
- srcLocColumn :: Int
- data StdoutResult
- data FileToRun = FileToRun {
- ftrName :: Text
- ftrContent :: FTRContent
- data FTRContent
- = FTRCText Text
- | FTRCBinary Base64
- data FayHoogleResults
- data IdeLicense
- data MaybeText
- data GitCheckoutResult
- data GitPullResult
- data GitPushResult
- data GitResolvedResult
- data MergeConflict = MergeConflict {}
- data RemotesList = RemotesList [(Text, Text)]
- data BranchesList = BranchesList BranchName [BranchName]
- data ProjectSettings = ProjectSettings {
- psModuleTemplate :: Text
- psExtensions :: [(Text, Maybe Bool)]
- psEnvironment :: Environment
- psEnvironments :: [Environment]
- psGhcArgs :: [Text]
- psBinaryGhcArgs :: [Text]
- psExtraPackages :: Text
- psAutoHidden :: [[(Bool, Text)]]
- psCabalName :: Text
- psCabalVersion :: Text
- psRoot :: Text
- psFilters :: Text
- data SetExtension = SetExtension Text Bool
- data SetSettingsInput = SetSettingsInput {
- ssiModuleTemplate :: Text
- ssiExtensions :: [SetExtension]
- ssiEnvironment :: Text
- ssiGhcArgs :: [Text]
- ssiBinaryGhcArgs :: [Text]
- ssiExtraPackages :: Text
- ssiAutohidden :: [[(Bool, Text)]]
- ssiCabalName :: Text
- ssiCabalVersion :: Text
- data Environment = Environment {}
- data RunGhciOutput = RunGhciOutput ProcId ProjectId
- data TopLevelIdentifiers = TopLevelIdentifiers [TopLevelIdentifier]
- data TopLevelIdentifier = TopLevelIdentifier {}
- data RefactoringContext
- data RefactoringOutput
- data TextReply = TextReply {
- unTextReply :: Text
- data HtmlReply = HtmlReply {
- unHtmlReply :: Text
- data RunConfig = RunConfig {
- rcTitle :: Text
- rcMainFile :: Maybe EncFileName
- rcArgs :: [Text]
- rcEnv :: [(Text, Text)]
- data NewRunConfig = NewRunConfig (RunConfigId, RunConfig)
- data Deployment = Deployment {
- depTitle :: Text
- depStanzas :: [Stanza]
- data Stanza
- data NewDeployment = NewDeployment (FayDeploymentId, Deployment)
- data WebApp = WebApp {
- wapTitle :: Text
- wapHostname :: Maybe Text
- wapFileName :: Maybe EncFileName
- wapArgs :: [Text]
- wapEnv :: [(Text, Text)]
- wapSsl :: Bool
- data NewWebApp = NewWebApp (FayWebAppId, WebApp)
- data BgJob = BgJob {
- bgTitle :: Text
- bgFileName :: Maybe EncFileName
- bgArgs :: [Text]
- bgEnv :: [(Text, Text)]
- bgRestartLimit :: Maybe Int
- bgRestartDelay :: Int
- data NewBgJob = NewBgJob (FayBgJobId, BgJob)
- data UseHostName
- data KeterYaml = KeterYaml {
- keterYaml :: Text
- deployYaml :: Text
- data RandomHostName = RandomHostName {}
- data ExpiryTime = ExpiryTime (Maybe Integer)
- data DeploymentManagerInfo = DeploymentManagerInfo {
- dmiHostname :: Text
- data FayDeploymentId = FayDeploymentId {}
- data FayBgJobId = FayBgJobId {
- unFayBgJobId :: Text
- data FayWebAppId = FayWebAppId {}
- data Theme
- data SearchQuery
- module FP.API.Runner
Documentation
data ProjectState Source
Constructors
| Workspaces | |
| UserState |
Instances
Instances
| Monad CanFail | |
| Functor CanFail | |
| Typeable1 CanFail | |
| Foldable CanFail | |
| Traversable CanFail | |
| Eq (Automatic a) => Eq (CanFail a) | |
| Data a => Data (CanFail a) | |
| Read (Automatic a) => Read (CanFail a) | |
| Show (Automatic a) => Show (CanFail a) | |
| Generic (CanFail a) | |
| ToJSON a => ToJSON (CanFail a) | |
| FromJSON a => FromJSON (CanFail a) |
Constructors
| CanFailT | |
Fields
| |
Instances
| MonadTrans CanFailT | |
| MonadBaseControl IO m => MonadBaseControl IO (CanFailT m) | |
| MonadBase IO m => MonadBase IO (CanFailT m) | |
| Monad m => Monad (CanFailT m) | |
| Functor m => Functor (CanFailT m) | |
| Monad m => MonadPlus (CanFailT m) | |
| (Functor m, Monad m) => Applicative (CanFailT m) | |
| Foldable f => Foldable (CanFailT f) | |
| Traversable f => Traversable (CanFailT f) | |
| (Functor m, Monad m) => Alternative (CanFailT m) | |
| MonadThrow m => MonadThrow (CanFailT m) | |
| MonadIO m => MonadIO (CanFailT m) | |
| MonadLogger m => MonadLogger (CanFailT m) | |
| MonadResource m => MonadResource (CanFailT m) |
eitherFail :: MonadFail m => m (Either Text a) -> m aSource
eitherToCanFail :: Show e => Either e a -> CanFail aSource
tryOrFail :: (MonadBaseControl IO m, MonadFail m) => m a -> m (CanFail a)Source
Try the given action, returning a Failure if it throw a RunnerException, otherwise returning Success or propagation any exceptions.
data RunnerProjectClosed Source
Constructors
| RunnerProjectClosed (Maybe SessionId) |
data GetProjectMessages Source
data ProjectMessagesRequest Source
Constructors
| PMRFirstRequest | |
| PMRLaterRequest Integer StatusHash MailboxId | The message sequence number and status hash we last got back. |
Instances
data IdeCommand Source
Constructors
Instances
data FayCommand Source
Constructors
| UserAuthedGithub (Returns' Bool) | |
| RevokeGithub (Returns' ()) | |
| GetGithubUrl Text (Returns' Text) | |
| SshPublicKey (Returns' Text) | |
| GenerateConfiguration (Returns' ()) | |
| GetIFilesFromCode Text Text (Maybe Text) (Returns' IFiles) | title, code, environment |
| GetIFilesFromURL Text (Returns' IFiles) | |
| SaveProfile Theme Int Bool (Returns' ()) | |
| GetProjectId Text (Returns' ProjectId) | |
| CloseAllProjects (Returns' ()) | |
| SetSettingsSubstitutions Text (Returns' ()) | |
| GetSettingsSubstitutions (Returns' Text) | |
| SeenAnnouncement Text (Returns' ()) | |
| GetAnnouncements (Returns' [(Text, Text, Text)]) |
Instances
data InitialProjectInfo Source
Values passed to the client when initially loading the IDE.
Constructors
| InitialProjectInfo | |
Fields
| |
Constructors
| IFiles | |
Fields
| |
Constructors
| IFile | |
Fields | |
data IFileContents Source
Constructors
| IFCText [IFileContent] | |
| IFCBase64 Base64 |
data IFileContent Source
Constructors
| IFCStatic Text | |
| IFCEditable Editable |
Constructors
| Editable | |
Fields
| |
Constructors
| SrcLoc | |
Fields
| |
data StdoutResult Source
Constructors
| SRSuccess Text | |
| SRTerminated ProcessResult |
Constructors
| FileToRun | |
Fields
| |
data FayHoogleResults Source
Constructors
| FayHoogleBadQuery Text | |
| FayHoogleResults Text [HoogleResult] (Maybe Int) | Text == HTML version of query, Int == total count |
data IdeLicense Source
Constructors
| ILCommunity | |
| ILPersonal | |
| ILProfessional |
data GitCheckoutResult Source
Result of checking out a branch (or ref, in future).
Constructors
| GCRDirty | |
| GCROk (Maybe RunnerProjectClosed) |
data GitPullResult Source
data GitPushResult Source
Constructors
| GURSuccess | |
| GURDirtyTree |
data GitResolvedResult Source
Constructors
| GRRSuccess | |
| GRRStillUnresolved [MergeConflict] |
data MergeConflict Source
Constructors
| MergeConflict | |
Fields | |
data RemotesList Source
Constructors
| RemotesList [(Text, Text)] |
data BranchesList Source
Constructors
| BranchesList BranchName [BranchName] |
data ProjectSettings Source
Constructors
| ProjectSettings | |
Fields
| |
data SetExtension Source
Constructors
| SetExtension Text Bool |
data SetSettingsInput Source
Constructors
| SetSettingsInput | |
Fields
| |
data RunGhciOutput Source
Constructors
| RunGhciOutput ProcId ProjectId |
data TopLevelIdentifiers Source
Constructors
| TopLevelIdentifiers [TopLevelIdentifier] |
data TopLevelIdentifier Source
data RefactoringContext Source
Constructors
| PortionContext SourceSpan Text | |
| ModuleContext ModuleName |
data RefactoringOutput Source
Constructors
| PortionOutput Text | |
| ModuleOutput Text |
A simple text reply.
Constructors
| TextReply | |
Fields
| |
An html reply.
Constructors
| HtmlReply | |
Fields
| |
A run configuration for a project.
data NewRunConfig Source
Make a new run configuration.
Constructors
| NewRunConfig (RunConfigId, RunConfig) |
data Deployment Source
A deployment configuration.
Constructors
| Deployment | |
Fields
| |
Possible stanza types.
Constructors
| WebAppStanza FayWebAppId WebApp | |
| BgJobStanza FayBgJobId BgJob |
data NewDeployment Source
Constructors
| NewDeployment (FayDeploymentId, Deployment) |
A web app stanza.
Constructors
| NewWebApp (FayWebAppId, WebApp) |
A background job stanza.
Constructors
| BgJob | |
Fields
| |
Make a new background job.
Constructors
| NewBgJob (FayBgJobId, BgJob) |
data UseHostName Source
Result of trying to use a hostname.
Constructors
| HostnameInUse | Host name is in use by someone else, can't be used. |
| HostnameOK | Host name was already or has now been registered and is now in use. |
| HostnameQuotaExcess | Couldn't register the hostname due to quota. |
| HostnameInvalid | Invalid hostname. |
Yaml text for a Keter config.
Constructors
| KeterYaml | |
Fields
| |
data ExpiryTime Source
A date of expiration, if any.
Constructors
| ExpiryTime (Maybe Integer) |
Instances
data DeploymentManagerInfo Source
Constructors
| DeploymentManagerInfo | |
Fields
| |
data FayDeploymentId Source
Constructors
| FayDeploymentId | |
Fields | |
data FayBgJobId Source
Constructors
| FayBgJobId | |
Fields
| |
data FayWebAppId Source
Constructors
| FayWebAppId | |
Fields | |
Themes supported by the IDE.
data SearchQuery Source
Constructors
| SearchQueryRegex Text | |
| SearchQueryPlain Text |
module FP.API.Runner