Yu.Core.Model.Internal

Model : Yu.Core.Model.Internal Description : The basic methods for model and types Copyright : (C) 2017-2018 Johann Lee [e-mail] License : GPL3 Maintainer : [e-mail] Stability : experimental Portability : unknown

The basic method and type for model in MVC

navigation bar

data Nav

model for navigation bar

Constructors

Nav

Fields

• navUrl :: Text

  The url of the link

• navLabel :: Text

  The label of the link

• navOrder :: Int

  The order of the link

Instances

Eq Nav

instance eq, order for nav

Methods

(==) :: Nav -> Nav -> Bool

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

Ord Nav

Methods

compare :: Nav -> Nav -> Ordering

(<) :: Nav -> Nav -> Bool

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

(>) :: Nav -> Nav -> Bool

(>=) :: Nav -> Nav -> Bool

max :: Nav -> Nav -> Nav

min :: Nav -> Nav -> Nav

Show Nav

Methods

showsPrec :: Int -> Nav -> ShowS

show :: Nav -> String

showList :: [Nav] -> ShowS

ToJSON Nav

instance Json(to)

Methods

toJSON :: Nav -> Value

toEncoding :: Nav -> Encoding

toJSONList :: [Nav] -> Value

toEncodingList :: [Nav] -> Encoding

navToDoc :: Nav -> Document

transform between nav and document

docToNav :: Document -> Maybe Nav

transform Document to nav

the resource

data ResT

the resource type for item

Constructors

ResT

Fields

• rIndex :: [Text]

  the path of the url

• rRes :: ObjectId

  the id of the object in the db

• rType :: Text

  the type of resource

• rCTime :: UTCTime

  the time when it created

• rUTime :: UTCTime

  the time when it updated

• rTitle :: Text

  the title

• rSummary :: Maybe Text

  the summary of result

• rWhose :: Maybe Text

  the own of the result

• rMIME :: Maybe Text

  the MIME type of the result

• rTags :: [Text]

  the tags for result

Instances

Eq ResT

Methods

(==) :: ResT -> ResT -> Bool

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

Show ResT

Methods

showsPrec :: Int -> ResT -> ShowS

show :: ResT -> String

showList :: [ResT] -> ShowS

ToJSON ResT

Methods

toJSON :: ResT -> Value

toEncoding :: ResT -> Encoding

toJSONList :: [ResT] -> Value

toEncodingList :: [ResT] -> Encoding

resToDoc :: ResT -> Document

transform between res document

docToRes :: Document -> Maybe ResT

transform between res document

transform

fromBinary :: Binary -> ByteString

Binary to ByteString

about mongoDB

class (MonadIO m, MonadBaseControl IO m) => Mongodic a m | m -> a where

the type-class which means mongoDB available.

Minimal complete definition

getDefaultAccessMode, getDefaultDb, getDbUP, getPool

Methods

getDefaultAccessMode

Arguments

:: m AccessMode

get the accedd mode

getDefaultDb

Arguments

:: m Database

get the default database

getDbUP

Arguments

:: m (Text, Text)

get the user and pass

getPool

Arguments

:: m ConnectionPool

get the connection pool

type ConnectionPool = Pool Pipe

ConnectionPool

fetchContext

Arguments

:: (MonadIO m, Val a)

=> Text

field name

-> ResT

resource index

-> Text

collection

-> Action m (Maybe a)

result

fetch context

fetchRes :: MonadIO m => [Text] -> Action m (Maybe ResT)

fetch resource index

fetchResAll :: (MonadIO m, MonadBaseControl IO m) => Action m [ResT]

fetch all resource index

updateContext

Arguments

:: (MonadIO m, Val a)

=> Text

collection

-> Maybe ObjectId

obj id of item

-> Text

field name

-> a

-> Action m ObjectId

return id

update context

updateItem

Arguments

:: (MonadIO m, Val a)

=> Text

type, or say collection

-> Text

field name

-> a

item

-> ResT

`undefined' ResT

-> Action m ()

the update for item

updateRes

Arguments

:: MonadIO m

=> ResT

the index

-> Action m ()

the update for resource

deleteContext

Arguments

:: MonadIO m

=> ResT

index

-> Text

collection

-> Action m ()

delete the context

deleteItem

Arguments

:: MonadIO m

=> [Text]

url

-> Text

collection

-> Action m ()

delete item

deleteRes

Arguments

:: MonadIO m

=> ResT

index

-> Action m ()

delete resource

deleteContextMaybe

Arguments

:: MonadIO m

=> Maybe ResT

index

-> Action m ()

delete the resouce in maybe

(=@) infix 0

Arguments

:: Val v

=> Label

label

-> Maybe v

value

-> Maybe Field

maybe field

update nothing

module Database.MongoDB

module Data.Pool