Aura.Types

Core Aura types.

Package Types

data Package

A package to be installed.

Constructors

FromRepo Prebuilt

FromAUR Buildable

Instances

Eq Package

Defined in Aura.Types

Methods

(==) :: Package -> Package -> Bool

(/=) :: Package -> Package -> Bool

Ord Package

Defined in Aura.Types

Methods

compare :: Package -> Package -> Ordering

(<) :: Package -> Package -> Bool

(<=) :: Package -> Package -> Bool

(>) :: Package -> Package -> Bool

(>=) :: Package -> Package -> Bool

max :: Package -> Package -> Package

min :: Package -> Package -> Package

pname :: Package -> PkgName

The name of a Package.

pprov :: Package -> Provides

Other names which allow this Package to be satisfied as a dependency.

pver :: Package -> Versioning

The version of a Package.

dividePkgs :: NESet Package -> These (NESet Prebuilt) (NESet Buildable)

data Dep

A dependency on another package.

Constructors

Dep

Fields

• name :: !PkgName
• demand :: !VersionDemand

Instances

Eq Dep

Defined in Aura.Types

Methods

(==) :: Dep -> Dep -> Bool

(/=) :: Dep -> Dep -> Bool

Ord Dep

Defined in Aura.Types

Methods

compare :: Dep -> Dep -> Ordering

(<) :: Dep -> Dep -> Bool

(<=) :: Dep -> Dep -> Bool

(>) :: Dep -> Dep -> Bool

(>=) :: Dep -> Dep -> Bool

max :: Dep -> Dep -> Dep

min :: Dep -> Dep -> Dep

Show Dep

Defined in Aura.Types

Methods

showsPrec :: Int -> Dep -> ShowS

show :: Dep -> String

showList :: [Dep] -> ShowS

Generic Dep

Defined in Aura.Types

Associated Types

type Rep Dep :: Type -> Type

Methods

from :: Dep -> Rep Dep x

to :: Rep Dep x -> Dep

type Rep Dep

Defined in Aura.Types

type Rep Dep = D1 (MetaData "Dep" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" False) (C1 (MetaCons "Dep" PrefixI True) (S1 (MetaSel (Just "name") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PkgName) :*: S1 (MetaSel (Just "demand") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 VersionDemand)))

parseDep :: Text -> Maybe Dep

Parse a dependency entry as it would appear in a PKGBUILD:

>>> parseDep "pacman>1.2.3"
Just (Dep {name = PkgName {name = "pacman"}, demand = >1.2.3})

renderedDep :: Dep -> Text

Renders the Dep into a form that pacman -T understands. The dual of parseDep.

data Buildable

A Package from the AUR that's buildable in some way on the user's machine.

Constructors

Buildable

Fields

• name :: !PkgName
• version :: !Versioning
• base :: !PkgName
• provides :: !Provides
• deps :: ![Dep]
• pkgbuild :: !Pkgbuild
• isExplicit :: !Bool

Instances

Eq Buildable

Defined in Aura.Types

Methods

(==) :: Buildable -> Buildable -> Bool

(/=) :: Buildable -> Buildable -> Bool

Ord Buildable

Defined in Aura.Types

Methods

compare :: Buildable -> Buildable -> Ordering

(<) :: Buildable -> Buildable -> Bool

(<=) :: Buildable -> Buildable -> Bool

(>) :: Buildable -> Buildable -> Bool

(>=) :: Buildable -> Buildable -> Bool

max :: Buildable -> Buildable -> Buildable

min :: Buildable -> Buildable -> Buildable

Show Buildable

Defined in Aura.Types

Methods

showsPrec :: Int -> Buildable -> ShowS

show :: Buildable -> String

showList :: [Buildable] -> ShowS

Generic Buildable

Defined in Aura.Types

Associated Types

type Rep Buildable :: Type -> Type

Methods

from :: Buildable -> Rep Buildable x

to :: Rep Buildable x -> Buildable

type Rep Buildable

Defined in Aura.Types

type Rep Buildable = D1 (MetaData "Buildable" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" False) (C1 (MetaCons "Buildable" PrefixI True) ((S1 (MetaSel (Just "name") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PkgName) :*: (S1 (MetaSel (Just "version") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Versioning) :*: S1 (MetaSel (Just "base") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PkgName))) :*: ((S1 (MetaSel (Just "provides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Provides) :*: S1 (MetaSel (Just "deps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Dep])) :*: (S1 (MetaSel (Just "pkgbuild") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Pkgbuild) :*: S1 (MetaSel (Just "isExplicit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)))))

data Prebuilt

A prebuilt Package from the official Arch repositories.

Constructors

Prebuilt

Fields

• name :: !PkgName
• version :: !Versioning
• base :: !PkgName
• provides :: !Provides

Instances

Eq Prebuilt

Defined in Aura.Types

Methods

(==) :: Prebuilt -> Prebuilt -> Bool

(/=) :: Prebuilt -> Prebuilt -> Bool

Ord Prebuilt

Defined in Aura.Types

Methods

compare :: Prebuilt -> Prebuilt -> Ordering

(<) :: Prebuilt -> Prebuilt -> Bool

(<=) :: Prebuilt -> Prebuilt -> Bool

(>) :: Prebuilt -> Prebuilt -> Bool

(>=) :: Prebuilt -> Prebuilt -> Bool

max :: Prebuilt -> Prebuilt -> Prebuilt

min :: Prebuilt -> Prebuilt -> Prebuilt

Show Prebuilt

Defined in Aura.Types

Methods

showsPrec :: Int -> Prebuilt -> ShowS

show :: Prebuilt -> String

showList :: [Prebuilt] -> ShowS

Generic Prebuilt

Defined in Aura.Types

Associated Types

type Rep Prebuilt :: Type -> Type

Methods

from :: Prebuilt -> Rep Prebuilt x

to :: Rep Prebuilt x -> Prebuilt

type Rep Prebuilt

Defined in Aura.Types

type Rep Prebuilt = D1 (MetaData "Prebuilt" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" False) (C1 (MetaCons "Prebuilt" PrefixI True) ((S1 (MetaSel (Just "name") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PkgName) :*: S1 (MetaSel (Just "version") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Versioning)) :*: (S1 (MetaSel (Just "base") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PkgName) :*: S1 (MetaSel (Just "provides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Provides))))

data SimplePkg

A package name with its version number.

Constructors

SimplePkg

Fields

• name :: !PkgName
• version :: !Versioning

Instances

Eq SimplePkg

Defined in Aura.Types

Methods

(==) :: SimplePkg -> SimplePkg -> Bool

(/=) :: SimplePkg -> SimplePkg -> Bool

Ord SimplePkg

Defined in Aura.Types

Methods

compare :: SimplePkg -> SimplePkg -> Ordering

(<) :: SimplePkg -> SimplePkg -> Bool

(<=) :: SimplePkg -> SimplePkg -> Bool

(>) :: SimplePkg -> SimplePkg -> Bool

(>=) :: SimplePkg -> SimplePkg -> Bool

max :: SimplePkg -> SimplePkg -> SimplePkg

min :: SimplePkg -> SimplePkg -> SimplePkg

Show SimplePkg

Defined in Aura.Types

Methods

showsPrec :: Int -> SimplePkg -> ShowS

show :: SimplePkg -> String

showList :: [SimplePkg] -> ShowS

Generic SimplePkg

Defined in Aura.Types

Associated Types

type Rep SimplePkg :: Type -> Type

Methods

from :: SimplePkg -> Rep SimplePkg x

to :: Rep SimplePkg x -> SimplePkg

type Rep SimplePkg

Defined in Aura.Types

type Rep SimplePkg = D1 (MetaData "SimplePkg" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" False) (C1 (MetaCons "SimplePkg" PrefixI True) (S1 (MetaSel (Just "name") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PkgName) :*: S1 (MetaSel (Just "version") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Versioning)))

simplepkg :: PackagePath -> Maybe SimplePkg

Attempt to create a SimplePkg from filepaths like /var/cache/pacman/pkg/linux-3.2.14-1-x86_64.pkg.tar.xz

simplepkg' :: Text -> Maybe SimplePkg

Attempt to create a SimplePkg from text like: xchat 2.8.8-19

Typeclasses

class Flagable a where

Types whose members can be converted to CLI flags.

Methods

asFlag :: a -> [Text]

Instances

Flagable Text

Defined in Aura.Types

Methods

asFlag :: Text -> [Text]

Flagable PkgGroup

Defined in Aura.Types

Methods

asFlag :: PkgGroup -> [Text]

Flagable PkgName

Defined in Aura.Types

Methods

asFlag :: PkgName -> [Text]

Flagable ColourMode

Defined in Aura.Settings

Methods

asFlag :: ColourMode -> [Text]

Flagable CommonSwitch

Defined in Aura.Settings

Methods

asFlag :: CommonSwitch -> [Text]

Flagable CommonConfig

Defined in Aura.Settings

Methods

asFlag :: CommonConfig -> [Text]

Flagable Makepkg

Defined in Aura.Settings

Methods

asFlag :: Makepkg -> [Text]

(Foldable f, Flagable a) => Flagable (f a)

Defined in Aura.Types

Methods

asFlag :: f a -> [Text]

Package Building

data VersionDemand

The versioning requirement of some package's dependency.

Constructors

LessThan Versioning

AtLeast Versioning

MoreThan Versioning

MustBe Versioning

Anything

Instances

Eq VersionDemand

Defined in Aura.Types

Methods

(==) :: VersionDemand -> VersionDemand -> Bool

(/=) :: VersionDemand -> VersionDemand -> Bool

Ord VersionDemand

Defined in Aura.Types

Methods

compare :: VersionDemand -> VersionDemand -> Ordering

(<) :: VersionDemand -> VersionDemand -> Bool

(<=) :: VersionDemand -> VersionDemand -> Bool

(>) :: VersionDemand -> VersionDemand -> Bool

(>=) :: VersionDemand -> VersionDemand -> Bool

max :: VersionDemand -> VersionDemand -> VersionDemand

min :: VersionDemand -> VersionDemand -> VersionDemand

Show VersionDemand

Defined in Aura.Types

Methods

showsPrec :: Int -> VersionDemand -> ShowS

show :: VersionDemand -> String

showList :: [VersionDemand] -> ShowS

_VersionDemand :: Traversal' VersionDemand Versioning

Attempt to zoom into the Versioning hiding within a VersionDemand.

data InstallType

The installation method.

Constructors

Pacman PkgName

Build Buildable

Instances

Eq InstallType

Defined in Aura.Types

Methods

(==) :: InstallType -> InstallType -> Bool

(/=) :: InstallType -> InstallType -> Bool

Errors

data DepError

The various ways that dependency resolution can fail.

Constructors

NonExistant PkgName

VerConflict (Doc AnsiStyle)

Ignored (Doc AnsiStyle)

BrokenProvides PkgName Provides PkgName

newtype Failure

Some failure message that when given the current runtime Language will produce a human-friendly error.

Constructors

Failure

Fields

• failure :: Language -> Doc AnsiStyle

Instances

Show Failure

Defined in Aura.Types

Methods

showsPrec :: Int -> Failure -> ShowS

show :: Failure -> String

showList :: [Failure] -> ShowS

Exception Failure

Defined in Aura.Types

Methods

toException :: Failure -> SomeException

fromException :: SomeException -> Maybe Failure

displayException :: Failure -> String

Language

data Language

All human languages available for text output.

Constructors

English

Japanese

Polish

Croatian

Swedish

German

Spanish

Portuguese

French

Russian

Italian

Serbian

Norwegian

Indonesia

Chinese

Esperanto

Instances

Bounded Language

Defined in Aura.Types

Methods

minBound :: Language

maxBound :: Language

Enum Language

Defined in Aura.Types

Methods

succ :: Language -> Language

pred :: Language -> Language

toEnum :: Int -> Language

fromEnum :: Language -> Int

enumFrom :: Language -> [Language]

enumFromThen :: Language -> Language -> [Language]

enumFromTo :: Language -> Language -> [Language]

enumFromThenTo :: Language -> Language -> Language -> [Language]

Eq Language

Defined in Aura.Types

Methods

(==) :: Language -> Language -> Bool

(/=) :: Language -> Language -> Bool

Ord Language

Defined in Aura.Types

Methods

compare :: Language -> Language -> Ordering

(<) :: Language -> Language -> Bool

(<=) :: Language -> Language -> Bool

(>) :: Language -> Language -> Bool

(>=) :: Language -> Language -> Bool

max :: Language -> Language -> Language

min :: Language -> Language -> Language

Show Language

Defined in Aura.Types

Methods

showsPrec :: Int -> Language -> ShowS

show :: Language -> String

showList :: [Language] -> ShowS

Other Wrappers

newtype PkgName

The name of an Arch Linux package.

Constructors

PkgName

Fields

• name :: Text

Instances

Eq PkgName

Defined in Aura.Types

Methods

(==) :: PkgName -> PkgName -> Bool

(/=) :: PkgName -> PkgName -> Bool

Ord PkgName

Defined in Aura.Types

Methods

compare :: PkgName -> PkgName -> Ordering

(<) :: PkgName -> PkgName -> Bool

(<=) :: PkgName -> PkgName -> Bool

(>) :: PkgName -> PkgName -> Bool

(>=) :: PkgName -> PkgName -> Bool

max :: PkgName -> PkgName -> PkgName

min :: PkgName -> PkgName -> PkgName

Show PkgName

Defined in Aura.Types

Methods

showsPrec :: Int -> PkgName -> ShowS

show :: PkgName -> String

showList :: [PkgName] -> ShowS

IsString PkgName

Defined in Aura.Types

Methods

fromString :: String -> PkgName

Generic PkgName

Defined in Aura.Types

Associated Types

type Rep PkgName :: Type -> Type

Methods

from :: PkgName -> Rep PkgName x

to :: Rep PkgName x -> PkgName

ToJSONKey PkgName

Defined in Aura.Types

Methods

toJSONKey :: ToJSONKeyFunction PkgName

toJSONKeyList :: ToJSONKeyFunction [PkgName]

FromJSONKey PkgName

Defined in Aura.Types

Methods

fromJSONKey :: FromJSONKeyFunction PkgName

fromJSONKeyList :: FromJSONKeyFunction [PkgName]

Flagable PkgName

Defined in Aura.Types

Methods

asFlag :: PkgName -> [Text]

type Rep PkgName

Defined in Aura.Types

type Rep PkgName = D1 (MetaData "PkgName" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" True) (C1 (MetaCons "PkgName" PrefixI True) (S1 (MetaSel (Just "name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype PkgGroup

A group that a Package could belong too, like base, base-devel, etc.

Constructors

PkgGroup

Fields

• group :: Text

Instances

Eq PkgGroup

Defined in Aura.Types

Methods

(==) :: PkgGroup -> PkgGroup -> Bool

(/=) :: PkgGroup -> PkgGroup -> Bool

Ord PkgGroup

Defined in Aura.Types

Methods

compare :: PkgGroup -> PkgGroup -> Ordering

(<) :: PkgGroup -> PkgGroup -> Bool

(<=) :: PkgGroup -> PkgGroup -> Bool

(>) :: PkgGroup -> PkgGroup -> Bool

(>=) :: PkgGroup -> PkgGroup -> Bool

max :: PkgGroup -> PkgGroup -> PkgGroup

min :: PkgGroup -> PkgGroup -> PkgGroup

Show PkgGroup

Defined in Aura.Types

Methods

showsPrec :: Int -> PkgGroup -> ShowS

show :: PkgGroup -> String

showList :: [PkgGroup] -> ShowS

Generic PkgGroup

Defined in Aura.Types

Associated Types

type Rep PkgGroup :: Type -> Type

Methods

from :: PkgGroup -> Rep PkgGroup x

to :: Rep PkgGroup x -> PkgGroup

Flagable PkgGroup

Defined in Aura.Types

Methods

asFlag :: PkgGroup -> [Text]

type Rep PkgGroup

Defined in Aura.Types

type Rep PkgGroup = D1 (MetaData "PkgGroup" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" True) (C1 (MetaCons "PkgGroup" PrefixI True) (S1 (MetaSel (Just "group") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype Provides

The dependency which some package provides. May not be the same name as the package itself (e.g. cronie provides cron).

Constructors

Provides

Fields

• provides :: PkgName

Instances

Eq Provides

Defined in Aura.Types

Methods

(==) :: Provides -> Provides -> Bool

(/=) :: Provides -> Provides -> Bool

Ord Provides

Defined in Aura.Types

Methods

compare :: Provides -> Provides -> Ordering

(<) :: Provides -> Provides -> Bool

(<=) :: Provides -> Provides -> Bool

(>) :: Provides -> Provides -> Bool

(>=) :: Provides -> Provides -> Bool

max :: Provides -> Provides -> Provides

min :: Provides -> Provides -> Provides

Show Provides

Defined in Aura.Types

Methods

showsPrec :: Int -> Provides -> ShowS

show :: Provides -> String

showList :: [Provides] -> ShowS

Generic Provides

Defined in Aura.Types

Associated Types

type Rep Provides :: Type -> Type

Methods

from :: Provides -> Rep Provides x

to :: Rep Provides x -> Provides

type Rep Provides

Defined in Aura.Types

type Rep Provides = D1 (MetaData "Provides" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" True) (C1 (MetaCons "Provides" PrefixI True) (S1 (MetaSel (Just "provides") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PkgName)))

newtype PackagePath

Filepaths like:

• /var/cache/pacman/pkg/linux-3.2.14-1-x86_64.pkg.tar.xz
• /var/cache/pacman/pkg/wine-1.4rc6-1-x86_64.pkg.tar.xz
• /var/cache/pacman/pkg/ruby-1.9.3_p125-4-x86_64.pkg.tar.xz

Constructors

PackagePath

Fields

• path :: Path Absolute

Instances

Eq PackagePath

Defined in Aura.Types

Methods

(==) :: PackagePath -> PackagePath -> Bool

(/=) :: PackagePath -> PackagePath -> Bool

Ord PackagePath

If they have the same package names, compare by their versions. Otherwise, do raw comparison of the path string.

Defined in Aura.Types

Methods

compare :: PackagePath -> PackagePath -> Ordering

(<) :: PackagePath -> PackagePath -> Bool

(<=) :: PackagePath -> PackagePath -> Bool

(>) :: PackagePath -> PackagePath -> Bool

(>=) :: PackagePath -> PackagePath -> Bool

max :: PackagePath -> PackagePath -> PackagePath

min :: PackagePath -> PackagePath -> PackagePath

Generic PackagePath

Defined in Aura.Types

Associated Types

type Rep PackagePath :: Type -> Type

Methods

from :: PackagePath -> Rep PackagePath x

to :: Rep PackagePath x -> PackagePath

type Rep PackagePath

Defined in Aura.Types

type Rep PackagePath = D1 (MetaData "PackagePath" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" True) (C1 (MetaCons "PackagePath" PrefixI True) (S1 (MetaSel (Just "path") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Path Absolute))))

newtype Pkgbuild

The contents of a PKGBUILD file.

Constructors

Pkgbuild

Fields

• pkgbuild :: ByteString

Instances

Eq Pkgbuild

Defined in Aura.Types

Methods

(==) :: Pkgbuild -> Pkgbuild -> Bool

(/=) :: Pkgbuild -> Pkgbuild -> Bool

Ord Pkgbuild

Defined in Aura.Types

Methods

compare :: Pkgbuild -> Pkgbuild -> Ordering

(<) :: Pkgbuild -> Pkgbuild -> Bool

(<=) :: Pkgbuild -> Pkgbuild -> Bool

(>) :: Pkgbuild -> Pkgbuild -> Bool

(>=) :: Pkgbuild -> Pkgbuild -> Bool

max :: Pkgbuild -> Pkgbuild -> Pkgbuild

min :: Pkgbuild -> Pkgbuild -> Pkgbuild

Show Pkgbuild

Defined in Aura.Types

Methods

showsPrec :: Int -> Pkgbuild -> ShowS

show :: Pkgbuild -> String

showList :: [Pkgbuild] -> ShowS

Generic Pkgbuild

Defined in Aura.Types

Associated Types

type Rep Pkgbuild :: Type -> Type

Methods

from :: Pkgbuild -> Rep Pkgbuild x

to :: Rep Pkgbuild x -> Pkgbuild

type Rep Pkgbuild

Defined in Aura.Types

type Rep Pkgbuild = D1 (MetaData "Pkgbuild" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" True) (C1 (MetaCons "Pkgbuild" PrefixI True) (S1 (MetaSel (Just "pkgbuild") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

type Environment = Map Text Text

Shell environment variables.

newtype User

The name of a user account on a Linux system.

Constructors

User

Fields

• user :: Text

Instances

Eq User

Defined in Aura.Types

Methods

(==) :: User -> User -> Bool

(/=) :: User -> User -> Bool

Show User

Defined in Aura.Types

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

Generic User

Defined in Aura.Types

Associated Types

type Rep User :: Type -> Type

Methods

from :: User -> Rep User x

to :: Rep User x -> User

type Rep User

Defined in Aura.Types

type Rep User = D1 (MetaData "User" "Aura.Types" "aura-2.1.0-9cTDkrxcFUh23Q42HQr0Vi" True) (C1 (MetaCons "User" PrefixI True) (S1 (MetaSel (Just "user") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))