Safe Haskell	None
Language	Haskell2010

Nix.String

Synopsis

data NixString
getContext :: NixString -> HashSet StringContext
makeNixString :: Text -> HashSet StringContext -> NixString
data StringContext = StringContext {
- scPath :: !Text
- scFlavor :: !ContextFlavor
}
data ContextFlavor
- = DirectPath
- | AllOutputs
- | DerivationOutput !Text
newtype NixLikeContext = NixLikeContext {
- getNixLikeContext :: HashMap Text NixLikeContextValue
}
data NixLikeContextValue = NixLikeContextValue {
- nlcvPath :: !Bool
- nlcvAllOutputs :: !Bool
- nlcvOutputs :: ![Text]
}
toNixLikeContext :: HashSet StringContext -> NixLikeContext
fromNixLikeContext :: NixLikeContext -> HashSet StringContext
stringHasContext :: NixString -> Bool
intercalateNixString :: NixString -> [NixString] -> NixString
getStringNoContext :: NixString -> Maybe Text
stringIgnoreContext :: NixString -> Text
makeNixStringWithoutContext :: Text -> NixString
makeNixStringWithSingletonContext :: Text -> StringContext -> NixString
modifyNixContents :: (Text -> Text) -> NixString -> NixString
type WithStringContext = WithStringContextT Identity
newtype WithStringContextT m a = WithStringContextT (WriterT (HashSet StringContext) m a)
extractNixString :: Monad m => NixString -> WithStringContextT m Text
addStringContext :: Monad m => HashSet StringContext -> WithStringContextT m ()
addSingletonStringContext :: Monad m => StringContext -> WithStringContextT m ()
runWithStringContextT :: Monad m => WithStringContextT m Text -> m NixString
runWithStringContextT' :: Monad m => WithStringContextT m a -> m (a, HashSet StringContext)
runWithStringContext :: WithStringContextT Identity Text -> NixString
runWithStringContext' :: WithStringContextT Identity a -> (a, HashSet StringContext)

Documentation

data NixString Source #

Instances

Instances details

Eq NixString Source #
Instance details Defined in Nix.String Methods (==) :: NixString -> NixString -> Bool # (/=) :: NixString -> NixString -> Bool #
Ord NixString Source #
Instance details Defined in Nix.String Methods compare :: NixString -> NixString -> Ordering # (<) :: NixString -> NixString -> Bool # (<=) :: NixString -> NixString -> Bool # (>) :: NixString -> NixString -> Bool # (>=) :: NixString -> NixString -> Bool # max :: NixString -> NixString -> NixString # min :: NixString -> NixString -> NixString #
Show NixString Source #
Instance details Defined in Nix.String Methods showsPrec :: Int -> NixString -> ShowS # show :: NixString -> String # showList :: [NixString] -> ShowS #
Generic NixString Source #
Instance details Defined in Nix.String Associated Types type Rep NixString :: Type -> Type # Methods from :: NixString -> Rep NixString x # to :: Rep NixString x -> NixString #
Semigroup NixString Source #
Instance details Defined in Nix.String Methods (<>) :: NixString -> NixString -> NixString # sconcat :: NonEmpty NixString -> NixString # stimes :: Integral b => b -> NixString -> NixString #
Monoid NixString Source #
Instance details Defined in Nix.String Methods mempty :: NixString # mappend :: NixString -> NixString -> NixString # mconcat :: [NixString] -> NixString #
Hashable NixString Source #
Instance details Defined in Nix.String Methods hashWithSalt :: Int -> NixString -> Int # hash :: NixString -> Int #
FromValue NixString m (Symbolic m) Source #
Instance details Defined in Nix.Lint Methods fromValue :: Symbolic m -> m NixString Source # fromValueMay :: Symbolic m -> m (Maybe NixString) Source #
Convertible e t f m => ToValue NixString m (NValue' t f m (NValue t f m)) Source #
Instance details Defined in Nix.Convert Methods toValue :: NixString -> m (NValue' t f m (NValue t f m)) Source #
(Convertible e t f m, MonadValue (NValue t f m) m, MonadEffects t f m) => FromValue NixString m (NValue' t f m (NValue t f m)) Source #
Instance details Defined in Nix.Convert Methods fromValue :: NValue' t f m (NValue t f m) -> m NixString Source # fromValueMay :: NValue' t f m (NValue t f m) -> m (Maybe NixString) Source #
type Rep NixString Source #
Instance details Defined in Nix.String type Rep NixString = D1 ('MetaData "NixString" "Nix.String" "hnix-0.13.1-b5yr3FpHjzZrJEmuWee0" 'False) (C1 ('MetaCons "NixString" 'PrefixI 'True) (S1 ('MetaSel ('Just "nsContents") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "nsContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashSet StringContext))))

getContext :: NixString -> HashSet StringContext Source #

makeNixString :: Text -> HashSet StringContext -> NixString Source #

Create NixString from a Text and context

data StringContext Source #

A Nix StringContext ...

Constructors

StringContext
Fields scPath :: !Text scFlavor :: !ContextFlavor

Instances

Instances details

Eq StringContext Source #
Instance details Defined in Nix.String Methods (==) :: StringContext -> StringContext -> Bool # (/=) :: StringContext -> StringContext -> Bool #
Ord StringContext Source #
Instance details Defined in Nix.String Methods compare :: StringContext -> StringContext -> Ordering # (<) :: StringContext -> StringContext -> Bool # (<=) :: StringContext -> StringContext -> Bool # (>) :: StringContext -> StringContext -> Bool # (>=) :: StringContext -> StringContext -> Bool # max :: StringContext -> StringContext -> StringContext # min :: StringContext -> StringContext -> StringContext #
Show StringContext Source #
Instance details Defined in Nix.String Methods showsPrec :: Int -> StringContext -> ShowS # show :: StringContext -> String # showList :: [StringContext] -> ShowS #
Generic StringContext Source #
Instance details Defined in Nix.String Associated Types type Rep StringContext :: Type -> Type # Methods from :: StringContext -> Rep StringContext x # to :: Rep StringContext x -> StringContext #
Hashable StringContext Source #
Instance details Defined in Nix.String Methods hashWithSalt :: Int -> StringContext -> Int # hash :: StringContext -> Int #
Monad m => MonadWriter (HashSet StringContext) (WithStringContextT m) Source #
Instance details Defined in Nix.String Methods writer :: (a, HashSet StringContext) -> WithStringContextT m a # tell :: HashSet StringContext -> WithStringContextT m () # listen :: WithStringContextT m a -> WithStringContextT m (a, HashSet StringContext) # pass :: WithStringContextT m (a, HashSet StringContext -> HashSet StringContext) -> WithStringContextT m a #
type Rep StringContext Source #
Instance details Defined in Nix.String type Rep StringContext = D1 ('MetaData "StringContext" "Nix.String" "hnix-0.13.1-b5yr3FpHjzZrJEmuWee0" 'False) (C1 ('MetaCons "StringContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "scPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "scFlavor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ContextFlavor)))

data ContextFlavor Source #

A ContextFlavor describes the sum of possible derivations for string contexts

Constructors

DirectPath
AllOutputs
DerivationOutput !Text

Instances

Instances details

Eq ContextFlavor Source #
Instance details Defined in Nix.String Methods (==) :: ContextFlavor -> ContextFlavor -> Bool # (/=) :: ContextFlavor -> ContextFlavor -> Bool #
Ord ContextFlavor Source #
Instance details Defined in Nix.String Methods compare :: ContextFlavor -> ContextFlavor -> Ordering # (<) :: ContextFlavor -> ContextFlavor -> Bool # (<=) :: ContextFlavor -> ContextFlavor -> Bool # (>) :: ContextFlavor -> ContextFlavor -> Bool # (>=) :: ContextFlavor -> ContextFlavor -> Bool # max :: ContextFlavor -> ContextFlavor -> ContextFlavor # min :: ContextFlavor -> ContextFlavor -> ContextFlavor #
Show ContextFlavor Source #
Instance details Defined in Nix.String Methods showsPrec :: Int -> ContextFlavor -> ShowS # show :: ContextFlavor -> String # showList :: [ContextFlavor] -> ShowS #
Generic ContextFlavor Source #
Instance details Defined in Nix.String Associated Types type Rep ContextFlavor :: Type -> Type # Methods from :: ContextFlavor -> Rep ContextFlavor x # to :: Rep ContextFlavor x -> ContextFlavor #
Hashable ContextFlavor Source #
Instance details Defined in Nix.String Methods hashWithSalt :: Int -> ContextFlavor -> Int # hash :: ContextFlavor -> Int #
type Rep ContextFlavor Source #
Instance details Defined in Nix.String type Rep ContextFlavor = D1 ('MetaData "ContextFlavor" "Nix.String" "hnix-0.13.1-b5yr3FpHjzZrJEmuWee0" 'False) (C1 ('MetaCons "DirectPath" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AllOutputs" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DerivationOutput" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))

newtype NixLikeContext Source #

Constructors

NixLikeContext
Fields getNixLikeContext :: HashMap Text NixLikeContextValue

Instances

Instances details

Eq NixLikeContext Source #
Instance details Defined in Nix.String Methods (==) :: NixLikeContext -> NixLikeContext -> Bool # (/=) :: NixLikeContext -> NixLikeContext -> Bool #
Ord NixLikeContext Source #
Instance details Defined in Nix.String Methods compare :: NixLikeContext -> NixLikeContext -> Ordering # (<) :: NixLikeContext -> NixLikeContext -> Bool # (<=) :: NixLikeContext -> NixLikeContext -> Bool # (>) :: NixLikeContext -> NixLikeContext -> Bool # (>=) :: NixLikeContext -> NixLikeContext -> Bool # max :: NixLikeContext -> NixLikeContext -> NixLikeContext # min :: NixLikeContext -> NixLikeContext -> NixLikeContext #
Show NixLikeContext Source #
Instance details Defined in Nix.String Methods showsPrec :: Int -> NixLikeContext -> ShowS # show :: NixLikeContext -> String # showList :: [NixLikeContext] -> ShowS #
Generic NixLikeContext Source #
Instance details Defined in Nix.String Associated Types type Rep NixLikeContext :: Type -> Type # Methods from :: NixLikeContext -> Rep NixLikeContext x # to :: Rep NixLikeContext x -> NixLikeContext #
type Rep NixLikeContext Source #
Instance details Defined in Nix.String type Rep NixLikeContext = D1 ('MetaData "NixLikeContext" "Nix.String" "hnix-0.13.1-b5yr3FpHjzZrJEmuWee0" 'True) (C1 ('MetaCons "NixLikeContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "getNixLikeContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Text NixLikeContextValue))))

data NixLikeContextValue Source #

Constructors

NixLikeContextValue
Fields nlcvPath :: !Bool nlcvAllOutputs :: !Bool nlcvOutputs :: ![Text]

Instances

Instances details

Eq NixLikeContextValue Source #
Instance details Defined in Nix.String Methods (==) :: NixLikeContextValue -> NixLikeContextValue -> Bool # (/=) :: NixLikeContextValue -> NixLikeContextValue -> Bool #
Ord NixLikeContextValue Source #
Instance details Defined in Nix.String Methods compare :: NixLikeContextValue -> NixLikeContextValue -> Ordering # (<) :: NixLikeContextValue -> NixLikeContextValue -> Bool # (<=) :: NixLikeContextValue -> NixLikeContextValue -> Bool # (>) :: NixLikeContextValue -> NixLikeContextValue -> Bool # (>=) :: NixLikeContextValue -> NixLikeContextValue -> Bool # max :: NixLikeContextValue -> NixLikeContextValue -> NixLikeContextValue # min :: NixLikeContextValue -> NixLikeContextValue -> NixLikeContextValue #
Show NixLikeContextValue Source #
Instance details Defined in Nix.String Methods showsPrec :: Int -> NixLikeContextValue -> ShowS # show :: NixLikeContextValue -> String # showList :: [NixLikeContextValue] -> ShowS #
Generic NixLikeContextValue Source #
Instance details Defined in Nix.String Associated Types type Rep NixLikeContextValue :: Type -> Type # Methods from :: NixLikeContextValue -> Rep NixLikeContextValue x # to :: Rep NixLikeContextValue x -> NixLikeContextValue #
Semigroup NixLikeContextValue Source #
Instance details Defined in Nix.String Methods (<>) :: NixLikeContextValue -> NixLikeContextValue -> NixLikeContextValue # sconcat :: NonEmpty NixLikeContextValue -> NixLikeContextValue # stimes :: Integral b => b -> NixLikeContextValue -> NixLikeContextValue #
Monoid NixLikeContextValue Source #
Instance details Defined in Nix.String Methods mempty :: NixLikeContextValue # mappend :: NixLikeContextValue -> NixLikeContextValue -> NixLikeContextValue # mconcat :: [NixLikeContextValue] -> NixLikeContextValue #
Convertible e t f m => ToValue NixLikeContextValue m (NValue' t f m (NValue t f m)) Source #
Instance details Defined in Nix.Convert Methods toValue :: NixLikeContextValue -> m (NValue' t f m (NValue t f m)) Source #
type Rep NixLikeContextValue Source #
Instance details Defined in Nix.String type Rep NixLikeContextValue = D1 ('MetaData "NixLikeContextValue" "Nix.String" "hnix-0.13.1-b5yr3FpHjzZrJEmuWee0" 'False) (C1 ('MetaCons "NixLikeContextValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "nlcvPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :: (S1 ('MetaSel ('Just "nlcvAllOutputs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "nlcvOutputs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]))))

toNixLikeContext :: HashSet StringContext -> NixLikeContext Source #

fromNixLikeContext :: NixLikeContext -> HashSet StringContext Source #

stringHasContext :: NixString -> Bool Source #

Returns True if the NixString has an associated context

intercalateNixString :: NixString -> [NixString] -> NixString Source #

Combine NixStrings with a separator

getStringNoContext :: NixString -> Maybe Text Source #

Extract the string contents from a NixString that has no context

stringIgnoreContext :: NixString -> Text Source #

Extract the string contents from a NixString even if the NixString has an associated context

makeNixStringWithoutContext :: Text -> NixString Source #

Constructs NixString without a context

makeNixStringWithSingletonContext :: Text -> StringContext -> NixString Source #

Create NixString using a singleton context

modifyNixContents :: (Text -> Text) -> NixString -> NixString Source #

Modify the string part of the NixString, leaving the context unchanged

type WithStringContext = WithStringContextT Identity Source #

newtype WithStringContextT m a Source #

A monad for accumulating string context while producing a result string.

Constructors

WithStringContextT (WriterT (HashSet StringContext) m a)

Instances

Instances details

MonadTrans WithStringContextT Source #
Instance details Defined in Nix.String Methods lift :: Monad m => m a -> WithStringContextT m a #
Monad m => Monad (WithStringContextT m) Source #
Instance details Defined in Nix.String Methods (>>=) :: WithStringContextT m a -> (a -> WithStringContextT m b) -> WithStringContextT m b # (>>) :: WithStringContextT m a -> WithStringContextT m b -> WithStringContextT m b # return :: a -> WithStringContextT m a #
Functor m => Functor (WithStringContextT m) Source #
Instance details Defined in Nix.String Methods fmap :: (a -> b) -> WithStringContextT m a -> WithStringContextT m b # (<$) :: a -> WithStringContextT m b -> WithStringContextT m a #
Applicative m => Applicative (WithStringContextT m) Source #
Instance details Defined in Nix.String Methods pure :: a -> WithStringContextT m a # (<>) :: WithStringContextT m (a -> b) -> WithStringContextT m a -> WithStringContextT m b # liftA2 :: (a -> b -> c) -> WithStringContextT m a -> WithStringContextT m b -> WithStringContextT m c # (>) :: WithStringContextT m a -> WithStringContextT m b -> WithStringContextT m b # (<*) :: WithStringContextT m a -> WithStringContextT m b -> WithStringContextT m a #
Monad m => MonadWriter (HashSet StringContext) (WithStringContextT m) Source #
Instance details Defined in Nix.String Methods writer :: (a, HashSet StringContext) -> WithStringContextT m a # tell :: HashSet StringContext -> WithStringContextT m () # listen :: WithStringContextT m a -> WithStringContextT m (a, HashSet StringContext) # pass :: WithStringContextT m (a, HashSet StringContext -> HashSet StringContext) -> WithStringContextT m a #

extractNixString :: Monad m => NixString -> WithStringContextT m Text Source #

Get the contents of a NixString and write its context into the resulting set.

addStringContext :: Monad m => HashSet StringContext -> WithStringContextT m () Source #

Add StringContexts into the resulting set.

addSingletonStringContext :: Monad m => StringContext -> WithStringContextT m () Source #

Add a StringContext into the resulting set.

runWithStringContextT :: Monad m => WithStringContextT m Text -> m NixString Source #

Run an action producing a string with a context and put those into a NixString.

runWithStringContextT' :: Monad m => WithStringContextT m a -> m (a, HashSet StringContext) Source #

Run an action that manipulates nix strings, and collect the contexts encountered. Warning: this may be unsafe, depending on how you handle the resulting context list.

runWithStringContext :: WithStringContextT Identity Text -> NixString Source #

Run an action producing a string with a context and put those into a NixString.

runWithStringContext' :: WithStringContextT Identity a -> (a, HashSet StringContext) Source #

Run an action that manipulates nix strings, and collect the contexts encountered. Warning: this may be unsafe, depending on how you handle the resulting context list.