PFile.Profile.Internal.Profile

Core types and functions related to profiles.

Documentation

absoluteRoot :: MonadReader Env m => Name -> m Root

Get directory path where entries of a Profile named Name are stored.

Since: 0.1.0.0

profileState :: MonadReader Env m => Name -> m Absolute

Get file path where serialized Profile named Name is stored.

Since: 0.1.0.0

profileRoot :: MonadReader Env m => Name -> m Absolute

Get directory path where absoluteRoot and profileState of a Profile named Name are located.

Since: 0.1.0.0

data Profile

Profile holds a list of Entryies.

Since: 0.1.0.0

Constructors

Profile

Fields

• name :: !Name

  Name of a Profile.

• state :: !State

  Current State of a Profile.

• entries :: ![Entry]

  List of a Profile Entryies.

Instances

FromJSON Profile

Defined in PFile.Profile.Internal.Profile

Methods

parseJSON :: Value -> Parser Profile

parseJSONList :: Value -> Parser [Profile]

ToJSON Profile

Defined in PFile.Profile.Internal.Profile

Methods

toJSON :: Profile -> Value

toEncoding :: Profile -> Encoding

toJSONList :: [Profile] -> Value

toEncodingList :: [Profile] -> Encoding

Generic Profile

Defined in PFile.Profile.Internal.Profile

Associated Types

type Rep Profile :: Type -> Type

Methods

from :: Profile -> Rep Profile x

to :: Rep Profile x -> Profile

type Rep Profile

Defined in PFile.Profile.Internal.Profile

type Rep Profile = D1 ('MetaData "Profile" "PFile.Profile.Internal.Profile" "pfile-0.1.0.1-2LtZGa2mKrg5ZSmQeq7wuJ" 'False) (C1 ('MetaCons "Profile" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Name) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 State) :*: S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Entry]))))

newtype Name

Name of a Profile.

Since: 0.1.0.0

Constructors

Name

Fields

• unName :: Text

Instances

FromJSON Name

Defined in PFile.Profile.Internal.Profile

Methods

parseJSON :: Value -> Parser Name

parseJSONList :: Value -> Parser [Name]

ToJSON Name

Defined in PFile.Profile.Internal.Profile

Methods

toJSON :: Name -> Value

toEncoding :: Name -> Encoding

toJSONList :: [Name] -> Value

toEncodingList :: [Name] -> Encoding

data State

Profiles state.

Since: 0.1.0.0

Constructors

Dangling

When an error is encountered during pushAll, create attempts to rollback. If the rollback fails, the profile is considered Dangling.

Valid

When create succeeds, the created profile has Valid state.

Instances

FromJSON State

Defined in PFile.Profile.Internal.Profile

Methods

parseJSON :: Value -> Parser State

parseJSONList :: Value -> Parser [State]

ToJSON State

Defined in PFile.Profile.Internal.Profile

Methods

toJSON :: State -> Value

toEncoding :: State -> Encoding

toJSONList :: [State] -> Value

toEncodingList :: [State] -> Encoding

data Entry

Entry represents a filesystem's object (directory, directory link, file, file link) that is mounted (or pushed) inside of a Profile.

Since: 0.1.0.0

Constructors

Entry

Fields

• mountPath :: !Mount

  Path to a filesystem's object mounted inside of a Profile.

• originPath :: !Absolute

  Path to a filesystem's object original location before pushing to a Profile.

Instances

FromJSON Entry

Defined in PFile.Profile.Internal.Profile

Methods

parseJSON :: Value -> Parser Entry

parseJSONList :: Value -> Parser [Entry]

ToJSON Entry

Defined in PFile.Profile.Internal.Profile

Methods

toJSON :: Entry -> Value

toEncoding :: Entry -> Encoding

toJSONList :: [Entry] -> Value

toEncodingList :: [Entry] -> Encoding

Generic Entry

Defined in PFile.Profile.Internal.Profile

Associated Types

type Rep Entry :: Type -> Type

Methods

from :: Entry -> Rep Entry x

to :: Rep Entry x -> Entry

type Rep Entry

Defined in PFile.Profile.Internal.Profile

type Rep Entry = D1 ('MetaData "Entry" "PFile.Profile.Internal.Profile" "pfile-0.1.0.1-2LtZGa2mKrg5ZSmQeq7wuJ" 'False) (C1 ('MetaCons "Entry" 'PrefixI 'True) (S1 ('MetaSel ('Just "mountPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Mount) :*: S1 ('MetaSel ('Just "originPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Absolute)))