Distribution.Types.ComponentId

Cabal-3.5.0.0: A framework for packaging Haskell software

Safe Haskell | Safe-Inferred
Language | Haskell2010

Distribution.Types.ComponentId

Synopsis

- data ComponentId
- unComponentId :: ComponentId -> String
- mkComponentId :: String -> ComponentId

# Documentation

data ComponentId Source #

A `ComponentId` uniquely identifies the transitive source code closure of a component (i.e. libraries, executables).

For non-Backpack components, this corresponds one to one with the `UnitId`, which serves as the basis for install paths, linker symbols, etc.

Use `mkComponentId` and `unComponentId` to convert from/to a `String`.

This type is opaque since `Cabal-2.0`

Since: Cabal-2.0.0.2

#### Instances

Instances details

Parsec ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods parsec :: CabalParsing m => m ComponentId Source #
Pretty ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods pretty :: ComponentId -> Doc Source # prettyVersioned :: CabalSpecVersion -> ComponentId -> Doc Source #
Structured ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods structure :: Proxy ComponentId -> Structure Source # structureHash' :: Tagged ComponentId MD5
Data ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ComponentId -> c ComponentId Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ComponentId Source # toConstr :: ComponentId -> Constr Source # dataTypeOf :: ComponentId -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ComponentId) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ComponentId) Source # gmapT :: (forall b. Data b => b -> b) -> ComponentId -> ComponentId Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ComponentId -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ComponentId -> r Source # gmapQ :: (forall d. Data d => d -> u) -> ComponentId -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> ComponentId -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ComponentId -> m ComponentId Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ComponentId -> m ComponentId Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ComponentId -> m ComponentId Source #
IsString ComponentId # | `mkComponentId` Since: Cabal-2.0.0.2
Instance details Defined in Distribution.Types.ComponentId Methods fromString :: String -> ComponentId Source #
Generic ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Associated Types type Rep ComponentId :: Type -> Type Source # Methods from :: ComponentId -> Rep ComponentId x Source # to :: Rep ComponentId x -> ComponentId Source #
Read ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods readsPrec :: Int -> ReadS ComponentId Source # readList :: ReadS [ComponentId] Source # readPrec :: ReadPrec ComponentId Source # readListPrec :: ReadPrec [ComponentId] Source #
Show ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods showsPrec :: Int -> ComponentId -> ShowS Source # show :: ComponentId -> String Source # showList :: [ComponentId] -> ShowS Source #
Binary ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods put :: ComponentId -> Put Source # get :: Get ComponentId Source # putList :: [ComponentId] -> Put Source #
NFData ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods rnf :: ComponentId -> () Source #
Eq ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods (==) :: ComponentId -> ComponentId -> Bool # (/=) :: ComponentId -> ComponentId -> Bool #
Ord ComponentId # |
Instance details Defined in Distribution.Types.ComponentId Methods compare :: ComponentId -> ComponentId -> Ordering # (<) :: ComponentId -> ComponentId -> Bool # (<=) :: ComponentId -> ComponentId -> Bool # (>) :: ComponentId -> ComponentId -> Bool # (>=) :: ComponentId -> ComponentId -> Bool # max :: ComponentId -> ComponentId -> ComponentId # min :: ComponentId -> ComponentId -> ComponentId #
type Rep ComponentId # |
Instance details Defined in Distribution.Types.ComponentId type Rep ComponentId = D1 ('MetaData "ComponentId" "Distribution.Types.ComponentId" "Cabal-3.5.0.0" 'True) (C1 ('MetaCons "ComponentId" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortText)))

unComponentId :: ComponentId -> String Source #

Convert `ComponentId` to `String`

Since: Cabal-2.0.0.2

mkComponentId :: String -> ComponentId Source #

Construct a `ComponentId` from a `String`

`mkComponentId` is the inverse to `unComponentId`

Note: No validations are performed to ensure that the resulting `ComponentId` is valid

Since: Cabal-2.0.0.2