Data.Library

Documentation

type Library = Seq LibraryItem

A Library is just a rebranded Seq

type ItemId = Int

data LibraryItem

An item in the library

Constructors

Deleted

Item

Fields

itemId :: !ItemId

itemName :: !Text256

itemDescription :: !(Maybe Text4096)

itemDateCreated :: !UTCTime

itemDateModified :: !UTCTime

itemParent :: !ItemId

itemType :: !(Either Directory UUIRI)

Instances

ToJSON LibraryItem

FromJSON LibraryItem

SafeCopy LibraryItem

data Error

Some errors that might occur

Constructors

InvalidDestination ItemId

ItemNotFound ItemId

MovingRoot

Instances

Show Error

move :: Library -> ItemId -> ItemId -> UTCTime -> Either Error Library

copy :: Library -> ItemId -> ItemId -> UTCTime -> Either Error Library

delete :: Library -> ItemId -> Library

rename :: Library -> ItemId -> Text -> UTCTime -> Library

Changes the name of an item

describe :: Library -> ItemId -> Text -> UTCTime -> Library

Sets the description of an item

touch :: Library -> ItemId -> UTCTime -> Library

Sets the modified date of an item to the one supplied in arg t

new :: Text -> Maybe Text -> UTCTime -> ItemId -> Maybe UUIRI -> Library -> Either Error Library

Create a new item in the library If createing a directory then uuiri must be Nothing

unsafeGetItem :: ItemId -> Library -> LibraryItem

No bounds checking and doesn't filter deleted items returns an exception error when the item is not found

getItem :: ItemId -> Library -> Either Error LibraryItem

Does bounds checking and also checks if the item was not deleted