Ribosome.Effect.PersistPath

Provide paths for Persist

Documentation

data PersistPath :: Effect where

This is a utility effect for Persist, determining the root directory for persistence files.

Constructors

PersistPath :: Maybe (Path Rel Dir) -> PersistPath m (Path Abs Dir)

Return the root if Nothing is given, or the subdir of the root if Just is given.

persistPath :: forall r. Member PersistPath r => Maybe (Path Rel Dir) -> Sem r (Path Abs Dir)

Return the root if Nothing is given, or the subdir of the root if Just is given.

setting :: Setting (Path Abs Dir)

This setting may be used to specify the root directory for all plugins. The default is to use the XDG cache dir.

persistRoot :: Member PersistPath r => Sem r (Path Abs Dir)

Get the root directory for persistence files.

persistSubPath :: Member PersistPath r => Path Rel Dir -> Sem r (Path Abs Dir)

Get a subdir of the root directory for persistence files.