Safe Haskell	Safe-Inferred
Language	GHC2021

Charon.Data.PathData

Contents

PathData

Description

Core PathData. This intended to be the main type representing path data. Actual backends are transformed to/from this type.

Synopsis

data PathData = UnsafePathData {
- pathType :: PathTypeW
- fileName :: PathI TrashEntryFileName
- originalPath :: PathI TrashEntryOriginalPath
- size :: Bytes B Natural
- created :: Timestamp
}
headerNames :: (IsList a, IsString (Item a)) => a
originalPathExists :: (HasCallStack, MonadCatch m, MonadPathReader m) => PathData -> m Bool
isDirectory :: PathData -> Bool

PathData

data PathData Source #

Data for a path. Maintains an invariant that the original path is not the root nor is it empty.

Constructors

UnsafePathData

Fields

pathType :: PathTypeW
The type of the path.
fileName :: PathI TrashEntryFileName
The path to be used in the trash directory.
originalPath :: PathI TrashEntryOriginalPath
The original path on the file system.
size :: Bytes B Natural
The size of the file or directory. This is the total size, i.e. in the case of a directory it is
size := size(dir) + size(dir contents)
created :: Timestamp
Time this entry was created.

Instances

Instances details

Generic PathData Source #
Instance details Defined in Charon.Data.PathData Associated Types type Rep PathData :: Type -> Type # Methods from :: PathData -> Rep PathData x # to :: Rep PathData x -> PathData #
Show PathData Source #
Instance details Defined in Charon.Data.PathData Methods showsPrec :: Int -> PathData -> ShowS # show :: PathData -> String # showList :: [PathData] -> ShowS #
NFData PathData Source #
Instance details Defined in Charon.Data.PathData Methods rnf :: PathData -> () #
Eq PathData Source #
Instance details Defined in Charon.Data.PathData Methods (==) :: PathData -> PathData -> Bool # (/=) :: PathData -> PathData -> Bool #
Hashable PathData Source #
Instance details Defined in Charon.Data.PathData Methods hashWithSalt :: Int -> PathData -> Int Source # hash :: PathData -> Int Source #
Pretty PathData Source #
Instance details Defined in Charon.Data.PathData Methods pretty :: PathData -> Doc ann Source # prettyList :: [PathData] -> Doc ann Source #
(k ~ A_Lens, a ~ Timestamp, b ~ Timestamp) => LabelOptic "created" k PathData PathData a b Source #
Instance details Defined in Charon.Data.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
(k ~ A_Lens, a ~ PathI 'TrashEntryFileName, b ~ PathI 'TrashEntryFileName) => LabelOptic "fileName" k PathData PathData a b Source #
Instance details Defined in Charon.Data.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
(k ~ A_Lens, a ~ PathI 'TrashEntryOriginalPath, b ~ PathI 'TrashEntryOriginalPath) => LabelOptic "originalPath" k PathData PathData a b Source #
Instance details Defined in Charon.Data.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
(k ~ A_Lens, a ~ PathTypeW, b ~ PathTypeW) => LabelOptic "pathType" k PathData PathData a b Source #
Instance details Defined in Charon.Data.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
(k ~ A_Lens, a ~ Bytes 'B Natural, b ~ Bytes 'B Natural) => LabelOptic "size" k PathData PathData a b Source #
Instance details Defined in Charon.Data.PathData Methods labelOptic :: Optic k NoIx PathData PathData a b Source #
type Rep PathData Source #
Instance details Defined in Charon.Data.PathData type Rep PathData = D1 ('MetaData "PathData" "Charon.Data.PathData" "charon-0.1-inplace" 'False) (C1 ('MetaCons "UnsafePathData" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pathType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PathTypeW) :: S1 ('MetaSel ('Just "fileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PathI 'TrashEntryFileName))) :: (S1 ('MetaSel ('Just "originalPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PathI 'TrashEntryOriginalPath)) :: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Bytes 'B Natural)) :: S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Timestamp)))))

headerNames :: (IsList a, IsString (Item a)) => a Source #

Header names.

originalPathExists :: (HasCallStack, MonadCatch m, MonadPathReader m) => PathData -> m Bool Source #

Returns True if the PathData's originalPath corresponds to a real path that exists.

isDirectory :: PathData -> Bool Source #