Servant.Seo.Robots

Robots.txt

RobotsInfo

data RobotsInfo

Intermediate structure representing robots.txt file. All API parts marked as Disallow would be aggregated into RobotsInfo during compilation and translated to robots.txt content.

Constructors

RobotsInfo

Fields

• _robotsSitemapPath :: Maybe ()

  Indicate whether sitemap should be present in robots file or not.

• _robotsDisallowedPaths :: [DisallowedPathPiece]

  Path pieces that should be present in robots file.

Instances

Eq RobotsInfo

Defined in Servant.Seo.Robots

Methods

(==) :: RobotsInfo -> RobotsInfo -> Bool

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

Show RobotsInfo

Defined in Servant.Seo.Robots

Methods

showsPrec :: Int -> RobotsInfo -> ShowS

show :: RobotsInfo -> String

showList :: [RobotsInfo] -> ShowS

Generic RobotsInfo

Defined in Servant.Seo.Robots

Associated Types

type Rep RobotsInfo :: Type -> Type

Methods

from :: RobotsInfo -> Rep RobotsInfo x

to :: Rep RobotsInfo x -> RobotsInfo

Semigroup RobotsInfo

Defined in Servant.Seo.Robots

Methods

(<>) :: RobotsInfo -> RobotsInfo -> RobotsInfo

sconcat :: NonEmpty RobotsInfo -> RobotsInfo

stimes :: Integral b => b -> RobotsInfo -> RobotsInfo

Monoid RobotsInfo

Empty unit of RobotsInfo.

Defined in Servant.Seo.Robots

Methods

mempty :: RobotsInfo

mappend :: RobotsInfo -> RobotsInfo -> RobotsInfo

mconcat :: [RobotsInfo] -> RobotsInfo

type Rep RobotsInfo

Defined in Servant.Seo.Robots

type Rep RobotsInfo = D1 (MetaData "RobotsInfo" "Servant.Seo.Robots" "servant-seo-0.1.2-inplace" False) (C1 (MetaCons "RobotsInfo" PrefixI True) (S1 (MetaSel (Just "_robotsSitemapPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ())) :*: S1 (MetaSel (Just "_robotsDisallowedPaths") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [DisallowedPathPiece])))

newtype DisallowedPathPiece

Part of URL that should be present in robots file.

Constructors

DisallowedPathPiece Text

Instances

Eq DisallowedPathPiece

Defined in Servant.Seo.Robots

Methods

(==) :: DisallowedPathPiece -> DisallowedPathPiece -> Bool

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

Ord DisallowedPathPiece

Defined in Servant.Seo.Robots

Methods

compare :: DisallowedPathPiece -> DisallowedPathPiece -> Ordering

(<) :: DisallowedPathPiece -> DisallowedPathPiece -> Bool

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

(>) :: DisallowedPathPiece -> DisallowedPathPiece -> Bool

(>=) :: DisallowedPathPiece -> DisallowedPathPiece -> Bool

max :: DisallowedPathPiece -> DisallowedPathPiece -> DisallowedPathPiece

min :: DisallowedPathPiece -> DisallowedPathPiece -> DisallowedPathPiece

Show DisallowedPathPiece

Defined in Servant.Seo.Robots

Methods

showsPrec :: Int -> DisallowedPathPiece -> ShowS

show :: DisallowedPathPiece -> String

showList :: [DisallowedPathPiece] -> ShowS

Generic DisallowedPathPiece

Defined in Servant.Seo.Robots

Associated Types

type Rep DisallowedPathPiece :: Type -> Type

Methods

from :: DisallowedPathPiece -> Rep DisallowedPathPiece x

to :: Rep DisallowedPathPiece x -> DisallowedPathPiece

ToMarkup DisallowedPathPiece

Defined in Servant.Seo.Robots

Methods

toMarkup :: DisallowedPathPiece -> Markup

preEscapedToMarkup :: DisallowedPathPiece -> Markup

type Rep DisallowedPathPiece

Defined in Servant.Seo.Robots

type Rep DisallowedPathPiece = D1 (MetaData "DisallowedPathPiece" "Servant.Seo.Robots" "servant-seo-0.1.2-inplace" True) (C1 (MetaCons "DisallowedPathPiece" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

robotsSitemapPath :: Lens' RobotsInfo (Maybe ())

robotsDisallowedPaths :: Lens' RobotsInfo [DisallowedPathPiece]

HasRobots

class HasRobots a where

Servant API extension. It describes how to build RobotsInfo from servant API. Most of types add nothing to it.

Methods

toRobots :: Proxy a -> RobotsInfo

Instances

HasRobots EmptyAPI

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy EmptyAPI -> RobotsInfo

HasRobots Raw

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy Raw -> RobotsInfo

(HasRobots a, HasRobots b) => HasRobots (a :<|> b :: Type)

Collect different path pieces.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (a :<|> b) -> RobotsInfo

HasRobots sub => HasRobots (HttpVersion :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (HttpVersion :> sub) -> RobotsInfo

(KnownSymbol sym, HasRobots sub) => HasRobots (Capture' mods sym a :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Capture' mods sym a :> sub) -> RobotsInfo

HasRobots sub => HasRobots (CaptureAll sym a :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (CaptureAll sym a :> sub) -> RobotsInfo

HasRobots api => HasRobots (Description desc :> api :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Description desc :> api) -> RobotsInfo

HasRobots api => HasRobots (Summary desc :> api :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Summary desc :> api) -> RobotsInfo

HasRobots sub => HasRobots (Header' mods sym a :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Header' mods sym a :> sub) -> RobotsInfo

HasRobots sub => HasRobots (IsSecure :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (IsSecure :> sub) -> RobotsInfo

HasRobots sub => HasRobots (QueryFlag sym :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (QueryFlag sym :> sub) -> RobotsInfo

HasRobots sub => HasRobots (QueryParam' mods sym a :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (QueryParam' mods sym a :> sub) -> RobotsInfo

HasRobots sub => HasRobots (QueryParams sym a :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (QueryParams sym a :> sub) -> RobotsInfo

HasRobots sub => HasRobots (RemoteHost :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (RemoteHost :> sub) -> RobotsInfo

HasRobots sub => HasRobots (ReqBody' mods cs a :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (ReqBody' mods cs a :> sub) -> RobotsInfo

HasRobots sub => HasRobots (StreamBody' mods fr ct a :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (StreamBody' mods fr ct a :> sub) -> RobotsInfo

HasRobots sub => HasRobots (Vault :> sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Vault :> sub) -> RobotsInfo

HasRobots api => HasRobots (Priority priority :> api :: Type)

Priority as part of sitemap.xml spec has no impact on robots.txt.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Priority priority :> api) -> RobotsInfo

(HasPeriod period, HasRobots api) => HasRobots (Frequency period :> api :: Type)

Frequency as part of sitemap.xml spec has no impact on robots.txt.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Frequency period :> api) -> RobotsInfo

(HasRobots sub, KnownSymbol sym) => HasRobots (Disallow sym :> sub :: Type)

Generate new DisallowedPathPiece from path piece marked as Disallow.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Disallow sym :> sub) -> RobotsInfo

(HasRobots sub, KnownSymbol sym) => HasRobots (sym :> sub :: Type)

Append path piece to existing DisallowedPathPiece.

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (sym :> sub) -> RobotsInfo

HasRobots sub => HasRobots (WithNamedContext x c sub :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (WithNamedContext x c sub) -> RobotsInfo

KnownNat status => HasRobots (Verb method status cs (Headers hs a) :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Verb method status cs (Headers hs a)) -> RobotsInfo

KnownNat status => HasRobots (Verb method status cs (Headers hs NoContent) :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Verb method status cs (Headers hs NoContent)) -> RobotsInfo

KnownNat status => HasRobots (Verb method status cs a :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Verb method status cs a) -> RobotsInfo

KnownNat status => HasRobots (Verb method status cs NoContent :: Type)

Defined in Servant.Seo.Robots

Methods

toRobots :: Proxy (Verb method status cs NoContent) -> RobotsInfo