charon-0.1: Template
Safe HaskellSafe-Inferred
LanguageGHC2021

Charon.Data.Index

Description

Provides types.

Synopsis

Documentation

newtype Index Source #

Index that stores the trash data.

Constructors

MkIndex 

Fields

Instances

Instances details
Generic Index Source # 
Instance details

Defined in Charon.Data.Index

Associated Types

type Rep Index :: Type -> Type #

Methods

from :: Index -> Rep Index x #

to :: Rep Index x -> Index #

Show Index Source # 
Instance details

Defined in Charon.Data.Index

Methods

showsPrec :: Int -> Index -> ShowS #

show :: Index -> String #

showList :: [Index] -> ShowS #

NFData Index Source # 
Instance details

Defined in Charon.Data.Index

Methods

rnf :: Index -> () #

Eq Index Source # 
Instance details

Defined in Charon.Data.Index

Methods

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

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

(k ~ An_Iso, a ~ Seq (PathDataCore, PathI 'TrashEntryPath), b ~ Seq (PathDataCore, PathI 'TrashEntryPath)) => LabelOptic "unIndex" k Index Index a b Source # 
Instance details

Defined in Charon.Data.Index

type Rep Index Source # 
Instance details

Defined in Charon.Data.Index

type Rep Index

empty :: Index Source #

Empty index.

Formatting

formatIndex Source #

Arguments

:: forall m. (HasCallStack, MonadAsync m, MonadCatch m, MonadLoggerNS m, MonadTerminal m) 
=> ListCmdP2

List config

-> Index

The index to format

-> m Text 

Formats the Index in a pretty way.

data Sort Source #

How to sort the index list.

Constructors

Name

Sort by name.

Size

Sort by size.

Instances

Instances details
Show Sort Source # 
Instance details

Defined in Charon.Data.PathData.Formatting

Methods

showsPrec :: Int -> Sort -> ShowS #

show :: Sort -> String #

showList :: [Sort] -> ShowS #

Eq Sort Source # 
Instance details

Defined in Charon.Data.PathData.Formatting

Methods

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

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

Low level utils

formatIndex' Source #

Arguments

:: forall m. (HasCallStack, MonadAsync m, MonadCatch m, MonadLoggerNS m, MonadTerminal m) 
=> ListCmdP2

List config

-> Seq PathDataCore

The index to format

-> m Text 

Formats the Index in a pretty way.