Copyright	Copyright (c) 2020-2025 Travis Cardwell
License	MIT
Safe Haskell	Safe-Inferred
Language	Haskell2010

QueueSheet.Types

Contents

Name
Url
Date
Section
Tag
Item
Queue
Import
ImportOrQueue
QueuesFile
QueueSheet

Description

Synopsis

newtype Name = Name Text
newtype Url = Url Text
newtype Date = Date Text
newtype Section = Section Text
defaultSection :: Section
newtype Tag = Tag Text
data Item = Item {
- itemName :: !Name
- itemUrl :: !(Maybe Url)
- itemTags :: ![Tag]
}
data Queue = Queue {
- queueName :: !Name
- queueUrl :: !(Maybe Url)
- queueDate :: !(Maybe Date)
- queueSection :: !Section
- queueTags :: ![Tag]
- queueItems :: !(Maybe (Either Item [Item]))
}
data Import = Import {
- importPath :: !FilePath
- importSection :: !(Maybe Section)
}
data ImportOrQueue
- = IQImport !Import
- | IQQueue !Queue
data QueuesFile = QueuesFile {
- qfSections :: ![Section]
- qfImportOrQueues :: ![ImportOrQueue]
}
data QueueSheet = QueueSheet {
- qsSections :: ![Section]
- qsQueues :: ![Queue]
}

Name

newtype Name Source #

Name of a queue or queue item

Since: 0.3.0.0

Constructors

Name Text

Instances

Instances details

FromJSON Name Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Name # parseJSONList :: Value -> Parser [Name] # omittedField :: Maybe Name #
Show Name Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #
Eq Name Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Render Name Source #
Instance details Defined in QueueSheet.Types Methods render :: Textual t => Name -> t #
ToGVal m Name Source #
Instance details Defined in QueueSheet.Types Methods toGVal :: Name -> GVal m #

Url

newtype Url Source #

URL of queue or queue item

Since: 0.3.0.0

Constructors

Url Text

Instances

Instances details

FromJSON Url Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Url # parseJSONList :: Value -> Parser [Url] # omittedField :: Maybe Url #
Show Url Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Url -> ShowS # show :: Url -> String # showList :: [Url] -> ShowS #
Eq Url Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Url -> Url -> Bool # (/=) :: Url -> Url -> Bool #
Render Url Source #
Instance details Defined in QueueSheet.Types Methods render :: Textual t => Url -> t #
ToGVal m Url Source #
Instance details Defined in QueueSheet.Types Methods toGVal :: Url -> GVal m #

Date

newtype Date Source #

Date of last queue update

Since: 0.3.0.0

Constructors

Date Text

Instances

Instances details

FromJSON Date Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Date # parseJSONList :: Value -> Parser [Date] # omittedField :: Maybe Date #
Show Date Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #
Eq Date Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Date -> Date -> Bool # (/=) :: Date -> Date -> Bool #
Render Date Source #
Instance details Defined in QueueSheet.Types Methods render :: Textual t => Date -> t #
ToGVal m Date Source #
Instance details Defined in QueueSheet.Types Methods toGVal :: Date -> GVal m #

Section

newtype Section Source #

Section used to organize queues

Since: 0.3.0.0

Constructors

Section Text

Instances

Instances details

FromJSON Section Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Section # parseJSONList :: Value -> Parser [Section] # omittedField :: Maybe Section #
Show Section Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Section -> ShowS # show :: Section -> String # showList :: [Section] -> ShowS #
Eq Section Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Section -> Section -> Bool # (/=) :: Section -> Section -> Bool #
Render Section Source #
Instance details Defined in QueueSheet.Types Methods render :: Textual t => Section -> t #
ToGVal m Section Source #
Instance details Defined in QueueSheet.Types Methods toGVal :: Section -> GVal m #

defaultSection :: Section Source #

The default section is represented as an empty string

Tag

newtype Tag Source #

Queue tag

Since: 0.3.0.0

Constructors

Tag Text

Instances

Instances details

FromJSON Tag Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Tag # parseJSONList :: Value -> Parser [Tag] # omittedField :: Maybe Tag #
Show Tag Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Tag -> ShowS # show :: Tag -> String # showList :: [Tag] -> ShowS #
Eq Tag Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Tag -> Tag -> Bool # (/=) :: Tag -> Tag -> Bool #

Item

data Item Source #

Queue item

Whitespace-separated tags are supported instead of CSV from 0.8.0.0.

Since: 0.5.0.0

Constructors

Item
Fields itemName :: !Name itemUrl :: !(Maybe Url) itemTags :: ![Tag]

Instances

Instances details

FromJSON Item Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Item # parseJSONList :: Value -> Parser [Item] # omittedField :: Maybe Item #
Show Item Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Item -> ShowS # show :: Item -> String # showList :: [Item] -> ShowS #
Eq Item Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Item -> Item -> Bool # (/=) :: Item -> Item -> Bool #
ToGVal m Item Source #
Instance details Defined in QueueSheet.Types Methods toGVal :: Item -> GVal m #

Queue

data Queue Source #

Queue information

Whitespace-separated items and tags are supported instead of CSV from 0.8.0.0.

Since: 0.5.0.0

Constructors

Queue
Fields queueName :: !Name queueUrl :: !(Maybe Url) queueDate :: !(Maybe Date) queueSection :: !Section queueTags :: ![Tag] queueItems :: !(Maybe (Either Item [Item]))

Instances

Instances details

FromJSON Queue Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Queue # parseJSONList :: Value -> Parser [Queue] # omittedField :: Maybe Queue #
Show Queue Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Queue -> ShowS # show :: Queue -> String # showList :: [Queue] -> ShowS #
Eq Queue Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Queue -> Queue -> Bool # (/=) :: Queue -> Queue -> Bool #

Import

data Import Source #

Import declaration

Since: 0.3.0.0

Constructors

Import
Fields importPath :: !FilePath importSection :: !(Maybe Section)

Instances

Instances details

FromJSON Import Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser Import # parseJSONList :: Value -> Parser [Import] # omittedField :: Maybe Import #
Show Import Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> Import -> ShowS # show :: Import -> String # showList :: [Import] -> ShowS #
Eq Import Source #
Instance details Defined in QueueSheet.Types Methods (==) :: Import -> Import -> Bool # (/=) :: Import -> Import -> Bool #

ImportOrQueue

data ImportOrQueue Source #

Import declaration or queue information

Since: 0.3.0.0

Constructors

IQImport !Import
IQQueue !Queue

Instances

Instances details

FromJSON ImportOrQueue Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser ImportOrQueue # parseJSONList :: Value -> Parser [ImportOrQueue] # omittedField :: Maybe ImportOrQueue #
Show ImportOrQueue Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> ImportOrQueue -> ShowS # show :: ImportOrQueue -> String # showList :: [ImportOrQueue] -> ShowS #
Eq ImportOrQueue Source #
Instance details Defined in QueueSheet.Types Methods (==) :: ImportOrQueue -> ImportOrQueue -> Bool # (/=) :: ImportOrQueue -> ImportOrQueue -> Bool #

QueuesFile

data QueuesFile Source #

Queues file

Since: 0.3.0.0

Constructors

QueuesFile
Fields qfSections :: ![Section] qfImportOrQueues :: ![ImportOrQueue]

Instances

Instances details

FromJSON QueuesFile Source #
Instance details Defined in QueueSheet.Types Methods parseJSON :: Value -> Parser QueuesFile # parseJSONList :: Value -> Parser [QueuesFile] # omittedField :: Maybe QueuesFile #
Show QueuesFile Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> QueuesFile -> ShowS # show :: QueuesFile -> String # showList :: [QueuesFile] -> ShowS #
Eq QueuesFile Source #
Instance details Defined in QueueSheet.Types Methods (==) :: QueuesFile -> QueuesFile -> Bool # (/=) :: QueuesFile -> QueuesFile -> Bool #

QueueSheet

data QueueSheet Source #

Queue sheet

Since: 0.3.0.0

Constructors

QueueSheet
Fields qsSections :: ![Section] qsQueues :: ![Queue]

Instances

Instances details

Show QueueSheet Source #
Instance details Defined in QueueSheet.Types Methods showsPrec :: Int -> QueueSheet -> ShowS # show :: QueueSheet -> String # showList :: [QueueSheet] -> ShowS #
Eq QueueSheet Source #
Instance details Defined in QueueSheet.Types Methods (==) :: QueueSheet -> QueueSheet -> Bool # (/=) :: QueueSheet -> QueueSheet -> Bool #