rating-chgk-info-0.3.6.3: Client for rating.chgk.info API and CSV tables (documentation in Russian)

Copyright(c) Mansur Ziiatdinov 2018-2019
LicenseBSD-3
Maintainerchgk@pm.me
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

RatingChgkInfo.Types.Unsafe

Contents

Description

Из этого модуля экспортируются функции, которые не являются безопасными с точки зрения типов.

Например, можно ошибиться и передать идентификатор игрока вместо идентификатора команды, если оба идентификатора имеют текстовый тип. Чтобы избежать этого класса ошибок мы используем разные типы для разных идентификаторов, а получить значения-идентификаторы можно только из запросов к API. Ну, или если хочется иметь возможность выстрелить в ногу — из этого модуля. Caveat emptor

Synopsis

Типы-идентификаторы

newtype PlayerId Source #

Идентификатор игрока. В API на самом деле возвращается строка, но во всех функциях работы с игроками используется этот тип. Чтобы получить значение этого типа следует получить данные из API

Constructors

PlayerId 

Fields

Instances
Eq PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Read PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Show PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Generic PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Associated Types

type Rep PlayerId :: * -> * #

Methods

from :: PlayerId -> Rep PlayerId x #

to :: Rep PlayerId x -> PlayerId #

FromJSON PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

parseJSON :: Value -> Parser PlayerId

parseJSONList :: Value -> Parser [PlayerId]

ToJSON PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

toJSON :: PlayerId -> Value

toEncoding :: PlayerId -> Encoding

toJSONList :: [PlayerId] -> Value

toEncodingList :: [PlayerId] -> Encoding

ToParamSchema PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

toParamSchema :: proxy PlayerId -> ParamSchema t

ToSchema PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

declareNamedSchema :: proxy PlayerId -> Declare (Definitions Schema) NamedSchema

FromHttpApiData PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

ToHttpApiData PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

type Rep PlayerId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

type Rep PlayerId = D1 (MetaData "PlayerId" "RatingChgkInfo.Types.Unsafe" "rating-chgk-info-0.3.6.3-inplace" True) (C1 (MetaCons "PlayerId" PrefixI True) (S1 (MetaSel (Just "unPlayerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype TeamId Source #

Идентификатор команды. В API на самом деле возвращается строка, но во всех функциях работы с командами используется этот тип. Чтобы получить значение этого типа следует получить данные из API

Constructors

TeamId 

Fields

Instances
Eq TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

(==) :: TeamId -> TeamId -> Bool #

(/=) :: TeamId -> TeamId -> Bool #

Read TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Show TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Generic TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Associated Types

type Rep TeamId :: * -> * #

Methods

from :: TeamId -> Rep TeamId x #

to :: Rep TeamId x -> TeamId #

FromJSON TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

parseJSON :: Value -> Parser TeamId

parseJSONList :: Value -> Parser [TeamId]

ToJSON TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

toJSON :: TeamId -> Value

toEncoding :: TeamId -> Encoding

toJSONList :: [TeamId] -> Value

toEncodingList :: [TeamId] -> Encoding

ToParamSchema TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

toParamSchema :: proxy TeamId -> ParamSchema t

ToSchema TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

declareNamedSchema :: proxy TeamId -> Declare (Definitions Schema) NamedSchema

FromHttpApiData TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

ToHttpApiData TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

type Rep TeamId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

type Rep TeamId = D1 (MetaData "TeamId" "RatingChgkInfo.Types.Unsafe" "rating-chgk-info-0.3.6.3-inplace" True) (C1 (MetaCons "TeamId" PrefixI True) (S1 (MetaSel (Just "unTeamId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

newtype TournamentId Source #

Идентификатор турнира. В API на самом деле возвращается строка, но во всех функциях работы с турнирами используется этот тип. Чтобы получить значение этого типа следует получить данные из API

Constructors

TournamentId 

Fields

Instances
Eq TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Read TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Show TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Generic TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Associated Types

type Rep TournamentId :: * -> * #

FromJSON TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

parseJSON :: Value -> Parser TournamentId

parseJSONList :: Value -> Parser [TournamentId]

ToJSON TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

toJSON :: TournamentId -> Value

toEncoding :: TournamentId -> Encoding

toJSONList :: [TournamentId] -> Value

toEncodingList :: [TournamentId] -> Encoding

ToParamSchema TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

toParamSchema :: proxy TournamentId -> ParamSchema t

ToSchema TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

Methods

declareNamedSchema :: proxy TournamentId -> Declare (Definitions Schema) NamedSchema

FromHttpApiData TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

ToHttpApiData TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

type Rep TournamentId Source # 
Instance details

Defined in RatingChgkInfo.Types.Unsafe

type Rep TournamentId = D1 (MetaData "TournamentId" "RatingChgkInfo.Types.Unsafe" "rating-chgk-info-0.3.6.3-inplace" True) (C1 (MetaCons "TournamentId" PrefixI True) (S1 (MetaSel (Just "unTournamentId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))