Safe Haskell	None
Language	GHC2021

Effectful.FileSystem.PathWriter.Utils

Contents

Config
Optics

Description

Provides utilities used by path writing.

Since: 0.1

Synopsis

data CopyDirConfig = MkCopyDirConfig {
- overwrite :: !Overwrite
- targetName :: !TargetName
}
defaultCopyDirConfig :: CopyDirConfig
data Overwrite
- = OverwriteNone
- | OverwriteDirectories
- | OverwriteAll
data TargetName
- = TargetNameSrc
- | TargetNameLiteral !OsPath
- | TargetNameDest
_OverwriteNone :: Prism' Overwrite ()
_OverwriteDirectories :: Prism' Overwrite ()
_OverwriteAll :: Prism' Overwrite ()
_TargetNameSrc :: Prism' TargetName ()
_TargetNameLiteral :: Prism' TargetName OsPath
_TargetNameDest :: Prism' TargetName ()

Config

data CopyDirConfig Source #

Directory copying config.

Since: 0.1

Constructors

MkCopyDirConfig
Fields overwrite :: !Overwrite Overwrite behavior. Since: 0.1 targetName :: !TargetName TargetName behavior. Since: 0.1

Instances

Instances details

NFData CopyDirConfig Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

rnf :: CopyDirConfig -> () #

Generic CopyDirConfig Source #

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Associated Types

type Rep CopyDirConfig

Since: fs-effectful-0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

type Rep CopyDirConfig = D1 ('MetaData "CopyDirConfig" "Effectful.FileSystem.PathWriter.Utils" "fs-effectful-0.1-inplace" 'False) (C1 ('MetaCons "MkCopyDirConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "overwrite") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Overwrite) :*: S1 ('MetaSel ('Just "targetName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TargetName)))

Methods

from :: CopyDirConfig -> Rep CopyDirConfig x #

to :: Rep CopyDirConfig x -> CopyDirConfig #

Show CopyDirConfig Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

showsPrec :: Int -> CopyDirConfig -> ShowS #

show :: CopyDirConfig -> String #

showList :: [CopyDirConfig] -> ShowS #

Eq CopyDirConfig Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

(==) :: CopyDirConfig -> CopyDirConfig -> Bool #

(/=) :: CopyDirConfig -> CopyDirConfig -> Bool #

(k ~ A_Lens, a ~ Overwrite, b ~ Overwrite) => LabelOptic "overwrite" k CopyDirConfig CopyDirConfig a b Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

labelOptic :: Optic k NoIx CopyDirConfig CopyDirConfig a b Source #

(k ~ A_Lens, a ~ TargetName, b ~ TargetName) => LabelOptic "targetName" k CopyDirConfig CopyDirConfig a b Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

labelOptic :: Optic k NoIx CopyDirConfig CopyDirConfig a b Source #

type Rep CopyDirConfig Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

type Rep CopyDirConfig = D1 ('MetaData "CopyDirConfig" "Effectful.FileSystem.PathWriter.Utils" "fs-effectful-0.1-inplace" 'False) (C1 ('MetaCons "MkCopyDirConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "overwrite") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Overwrite) :*: S1 ('MetaSel ('Just "targetName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TargetName)))

defaultCopyDirConfig :: CopyDirConfig Source #

Default config for copying directories.

>>> defaultCopyDirConfig
MkCopyDirConfig {overwrite = OverwriteNone, destName = TargetNameSrc}

Since: 0.1

data Overwrite Source #

Determines file/directory overwrite behavior.

Since: 0.1

Constructors

OverwriteNone

No overwriting allowed.

Since: 0.1

OverwriteDirectories

Allow overwriting directories.

Since: 0.1

OverwriteAll

Allow overwriting the target directory and all subpaths.

Since: 0.1

Instances

Instances details

NFData Overwrite Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

rnf :: Overwrite -> () #

Generic Overwrite Source #

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Associated Types

type Rep Overwrite

Since: fs-effectful-0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

type Rep Overwrite = D1 ('MetaData "Overwrite" "Effectful.FileSystem.PathWriter.Utils" "fs-effectful-0.1-inplace" 'False) (C1 ('MetaCons "OverwriteNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OverwriteDirectories" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OverwriteAll" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Overwrite -> Rep Overwrite x #

to :: Rep Overwrite x -> Overwrite #

Show Overwrite Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

showsPrec :: Int -> Overwrite -> ShowS #

show :: Overwrite -> String #

showList :: [Overwrite] -> ShowS #

Eq Overwrite Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

Methods

(==) :: Overwrite -> Overwrite -> Bool #

(/=) :: Overwrite -> Overwrite -> Bool #

type Rep Overwrite Source #

Since: 0.1

Instance details

Defined in Effectful.FileSystem.PathWriter.Utils

type Rep Overwrite = D1 ('MetaData "Overwrite" "Effectful.FileSystem.PathWriter.Utils" "fs-effectful-0.1-inplace" 'False) (C1 ('MetaCons "OverwriteNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OverwriteDirectories" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OverwriteAll" 'PrefixI 'False) (U1 :: Type -> Type)))

data TargetName Source #

Determines how to name the target.

Since: 0.1

Constructors

TargetNameSrc

Uses the src dir as the dest name i.e. dest/<src>.

Since: 0.1

TargetNameLiteral !OsPath

Uses the given literal as the dest name i.e. dest/<targetName>.

Since: 0.1

TargetNameDest

Uses dest itself as the target i.e. dest/ (top-level copy).