Xrefcheck.Data.Redirect

Documentation

data RedirectChain

Links in a redirection chain.

Instances

Show RedirectChain

Defined in Xrefcheck.Data.Redirect

Methods

showsPrec :: Int -> RedirectChain -> ShowS

show :: RedirectChain -> String

showList :: [RedirectChain] -> ShowS

Buildable RedirectChain

Defined in Xrefcheck.Data.Redirect

Methods

build :: RedirectChain -> Builder

Eq RedirectChain

Defined in Xrefcheck.Data.Redirect

Methods

(==) :: RedirectChain -> RedirectChain -> Bool

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

FromList RedirectChain

Defined in Xrefcheck.Data.Redirect

Associated Types

type ListElement RedirectChain

type FromListC RedirectChain

Methods

fromList :: [ListElement RedirectChain] -> RedirectChain

type FromListC RedirectChain

Defined in Xrefcheck.Data.Redirect

type FromListC RedirectChain = ()

type ListElement RedirectChain

Defined in Xrefcheck.Data.Redirect

type ListElement RedirectChain = Text

newtype RedirectChainLink

A single link in a redirection chain.

Constructors

RedirectChainLink

Fields

• unRedirectChainLink :: Text

Instances

Show RedirectChainLink

Defined in Xrefcheck.Data.Redirect

Methods

showsPrec :: Int -> RedirectChainLink -> ShowS

show :: RedirectChainLink -> String

showList :: [RedirectChainLink] -> ShowS

Eq RedirectChainLink

Defined in Xrefcheck.Data.Redirect

Methods

(==) :: RedirectChainLink -> RedirectChainLink -> Bool

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

emptyChain :: RedirectChain

pushRequest :: RedirectChain -> RedirectChainLink -> RedirectChain

hasRequest :: RedirectChain -> RedirectChainLink -> Bool

totalFollowed :: RedirectChain -> Int

data RedirectRule

A custom redirect rule.

Constructors

RedirectRule

Fields

• rrFrom :: Maybe Regex

  Redirect source links that match to apply the rule.

  Nothing matches any link.

• rrTo :: Maybe Regex

  Redirect target links that match to apply the rule.

  Nothing matches any link.

• rrOn :: Maybe RedirectRuleOn

  HTTP code selector to apply the rule.

  Nothing matches any code.

• rrOutcome :: RedirectRuleOutcome

  What to do when an HTTP response matches the rule.

Instances

FromJSON RedirectRule

Defined in Xrefcheck.Data.Redirect

Methods

parseJSON :: Value -> Parser RedirectRule

parseJSONList :: Value -> Parser [RedirectRule]

omittedField :: Maybe RedirectRule

Generic RedirectRule

Defined in Xrefcheck.Data.Redirect

Associated Types

type Rep RedirectRule :: Type -> Type

Methods

from :: RedirectRule -> Rep RedirectRule x

to :: Rep RedirectRule x -> RedirectRule

type Rep RedirectRule

Defined in Xrefcheck.Data.Redirect

type Rep RedirectRule = D1 ('MetaData "RedirectRule" "Xrefcheck.Data.Redirect" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "RedirectRule" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rrFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Regex)) :*: S1 ('MetaSel ('Just "rrTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Regex))) :*: (S1 ('MetaSel ('Just "rrOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe RedirectRuleOn)) :*: S1 ('MetaSel ('Just "rrOutcome") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RedirectRuleOutcome))))

data RedirectRuleOn

Rule selector depending on the response HTTP code.

Constructors

RROCode Int

An exact HTTP code

RROPermanent

Any HTTP code considered as permanent according to isPermanentRedirectCode

RROTemporary

Any HTTP code considered as permanent according to isTemporaryRedirectCode

Instances

FromJSON RedirectRuleOn

Defined in Xrefcheck.Data.Redirect

Methods

parseJSON :: Value -> Parser RedirectRuleOn

parseJSONList :: Value -> Parser [RedirectRuleOn]

omittedField :: Maybe RedirectRuleOn

Show RedirectRuleOn

Defined in Xrefcheck.Data.Redirect

Methods

showsPrec :: Int -> RedirectRuleOn -> ShowS

show :: RedirectRuleOn -> String

showList :: [RedirectRuleOn] -> ShowS

Eq RedirectRuleOn

Defined in Xrefcheck.Data.Redirect

Methods

(==) :: RedirectRuleOn -> RedirectRuleOn -> Bool

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

data RedirectRuleOutcome

What to do when receiving a redirect HTTP response.

Constructors

RROValid

Consider it as valid

RROInvalid

Consider it as invalid

RROFollow

Try again by following the redirect

Instances

FromJSON RedirectRuleOutcome

Defined in Xrefcheck.Data.Redirect

Methods

parseJSON :: Value -> Parser RedirectRuleOutcome

parseJSONList :: Value -> Parser [RedirectRuleOutcome]

omittedField :: Maybe RedirectRuleOutcome

Show RedirectRuleOutcome

Defined in Xrefcheck.Data.Redirect

Methods

showsPrec :: Int -> RedirectRuleOutcome -> ShowS

show :: RedirectRuleOutcome -> String

showList :: [RedirectRuleOutcome] -> ShowS

Eq RedirectRuleOutcome

Defined in Xrefcheck.Data.Redirect

Methods

(==) :: RedirectRuleOutcome -> RedirectRuleOutcome -> Bool

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

redirectRule :: Text -> Text -> Int -> [RedirectRule] -> Maybe RedirectRule

Redirect rule to apply to a link when it has been responded with a given HTTP code.

isPermanentRedirectCode :: Int -> Bool

isRedirectCode :: Int -> Bool

isTemporaryRedirectCode :: Int -> Bool