Copyright	(c) 2024 Illia Shkroba
License	BSD3
Maintainer	Illia Shkroba <is@pjwstk.edu.pl>
Stability	unstable
Portability	non-portable (Non-Unix systems are not supported)
Safe Haskell	Safe-Inferred
Language	Haskell2010

PFile.Profile.Internal.Lifetime

Description

Types and functions for managing profiles lifetime.

Synopsis

create :: forall m. (MonadReader Env m, MonadError CreateError m, MonadIO m) => CreateOptions -> Name -> [Absolute] -> m Profile
showCreateError :: CreateError -> Text
data CreateError
- = ProfileAlreadyExistsError !Name
- | PushRollbackError !CreateRollbackCause ![(Entry, PopError)] !Absolute !(Maybe DumpError)
- | PushCreateError !CreateRollbackCause
showCreateRollbackCause :: CreateRollbackCause -> Text
data CreateRollbackCause
- = PushError !PushError
- | DumpError !DumpError
newtype CreateOptions = CreateOptions {
- linkHandlingStrategy :: Strategy
}

Documentation

create Source #

Arguments

:: forall m. (MonadReader Env m, MonadError CreateError m, MonadIO m)
=> CreateOptions	Options that control `create` behaviour (currently only `linkHandlingStrategy`).
-> Name	`Name` of a profile to be created. The name will be used as a directory name for the profile in `profilesHomeDirPath`.
-> [Absolute]	List of `Absolute` paths of filesystem's objects to be `push`ed into a profile.
-> m Profile

Create a new profile called Name with a list of Absolute filesystem's objects to be pushed inside of a profilesHomeDirPath directory. When an error is encountered during pushAll, create attempts to rollback. If the rollback fails, the profile is considered Dangling. Only Valid profiles are returned.

Since: 0.1.0.0

showCreateError :: CreateError -> Text Source #

data CreateError Source #

Error thrown by create.

Since: 0.1.0.0

Constructors

ProfileAlreadyExistsError !Name	'PFile.Profile.Internal.Profile.Profile with `Name` was found in `profilesHomeDirPath`.
PushRollbackError	`create` attempted to rollback due to `CreateRollbackCause`. The rollback has failed with a list of `PopError`s. Since the rollback has failed, the profile passed to `create` is considered `Dangling`.
Fields !CreateRollbackCause Cause of rollback. ![(Entry, PopError)] List of errors encountered during rollback. !Absolute Path to a profile's root directory. !(Maybe DumpError) Possible error that could appear during `dump` attempt of the profile.
PushCreateError !CreateRollbackCause	`create` attempted to rollback due to `CreateRollbackCause`. The rollback has succeeded. The profile passed to `create` was not created.

showCreateRollbackCause :: CreateRollbackCause -> Text Source #

data CreateRollbackCause Source #

create rollback cause.

Since: 0.1.0.0

Constructors

PushError !PushError	Error was encountered during `pushAll`.
DumpError !DumpError	Error was encountered during `dump`.

newtype CreateOptions Source #

create options.

Since: 0.1.0.0

Constructors

CreateOptions
Fields linkHandlingStrategy :: Strategy `Strategy` to be used when `push`ing a link into a profile.