Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Federation.Version

Contents

Version, VersionInfo
VersionRange

Synopsis

data Version
- = V0
- | V1
- | V2
type family V0Sym0 :: Version where ...
type family V1Sym0 :: Version where ...
type family V2Sym0 :: Version where ...
intToVersion :: Int -> Maybe Version
versionInt :: Version -> Int
versionText :: Version -> Text
supportedVersions :: Set Version
data VersionInfo = VersionInfo {
- vinfoSupported :: [Int]
}
versionInfo :: VersionInfo
data VersionUpperBound
- = VersionUpperBound Version
- | Unbounded
data VersionRange = VersionRange {
- _fromVersion :: Version
- _toVersionExcl :: VersionUpperBound
}
allVersions :: VersionRange
latestCommonVersion :: Foldable f => VersionRange -> f Int -> Maybe Version
rangeFromVersion :: Version -> VersionRange
rangeUntilVersion :: Version -> VersionRange

Version, VersionInfo

data Version Source #

Constructors

V0
V1
V2

Instances

Instances details

FromJSON Version Source #
Instance details Defined in Wire.API.Federation.Version Methods parseJSON :: Value -> Parser Version Source # parseJSONList :: Value -> Parser [Version] Source #
ToJSON Version Source #
Instance details Defined in Wire.API.Federation.Version Methods toJSON :: Version -> Value Source # toEncoding :: Version -> Encoding Source # toJSONList :: [Version] -> Value Source # toEncodingList :: [Version] -> Encoding Source #
Bounded Version Source #
Instance details Defined in Wire.API.Federation.Version Methods minBound :: Version # maxBound :: Version #
Enum Version Source #
Instance details Defined in Wire.API.Federation.Version Methods succ :: Version -> Version # pred :: Version -> Version # toEnum :: Int -> Version # fromEnum :: Version -> Int # enumFrom :: Version -> [Version] # enumFromThen :: Version -> Version -> [Version] # enumFromTo :: Version -> Version -> [Version] # enumFromThenTo :: Version -> Version -> Version -> [Version] #
Generic Version Source #
Instance details Defined in Wire.API.Federation.Version Associated Types type Rep Version :: Type -> Type # Methods from :: Version -> Rep Version x # to :: Rep Version x -> Version #
Show Version Source #
Instance details Defined in Wire.API.Federation.Version Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Eq Version Source #
Instance details Defined in Wire.API.Federation.Version Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in Wire.API.Federation.Version Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
ToSchema Version Source #
Instance details Defined in Wire.API.Federation.Version Methods schema :: ValueSchema NamedSwaggerDoc Version Source #
SingKind Version Source #
Instance details Defined in Wire.API.Federation.Version Associated Types type Demote Version = (r :: Type) Source # Methods fromSing :: forall (a :: Version). Sing a -> Demote Version Source # toSing :: Demote Version -> SomeSing Version Source #
POrd Version Source #
Instance details Defined in Wire.API.Federation.Version Associated Types type Compare arg arg1 :: Ordering Source # type arg < arg1 :: Bool Source # type arg <= arg1 :: Bool Source # type arg > arg1 :: Bool Source # type arg >= arg1 :: Bool Source # type Max arg arg1 :: a Source # type Min arg arg1 :: a Source #
SingI 'V0 Source #
Instance details Defined in Wire.API.Federation.Version Methods sing :: Sing 'V0 Source #
SingI 'V1 Source #
Instance details Defined in Wire.API.Federation.Version Methods sing :: Sing 'V1 Source #
SingI 'V2 Source #
Instance details Defined in Wire.API.Federation.Version Methods sing :: Sing 'V2 Source #
VersionedMonad Version (FederatorClient c) Source #
Instance details Defined in Wire.API.Federation.Client Methods guardVersion :: (Version -> Bool) -> FederatorClient c () Source #
(IsNamed name, SingI v) => IsNamed (Versioned v name :: Type) Source #
Instance details Defined in Wire.API.Federation.API Methods nameVal' :: Text Source #
type Rep Version Source #
Instance details Defined in Wire.API.Federation.Version type Rep Version = D1 ('MetaData "Version" "Wire.API.Federation.Version" "wire-api-federation-0.1.0-KrCnHof6TO1avA0Ur7PtD" 'False) (C1 ('MetaCons "V0" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "V1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "V2" 'PrefixI 'False) (U1 :: Type -> Type)))
type Demote Version Source #
Instance details Defined in Wire.API.Federation.Version type Demote Version = Version
type Sing Source #
Instance details Defined in Wire.API.Federation.Version type Sing
type (arg :: Version) < (arg1 :: Version) Source #
Instance details Defined in Wire.API.Federation.Version type (arg :: Version) < (arg1 :: Version) = Apply (Apply (TFHelper_6989586621679359029Sym0 :: TyFun Version (Version ~> Bool) -> Type) arg) arg1
type (arg :: Version) <= (arg1 :: Version) Source #
Instance details Defined in Wire.API.Federation.Version type (arg :: Version) <= (arg1 :: Version) = Apply (Apply (TFHelper_6989586621679359045Sym0 :: TyFun Version (Version ~> Bool) -> Type) arg) arg1
type (arg :: Version) > (arg1 :: Version) Source #
Instance details Defined in Wire.API.Federation.Version type (arg :: Version) > (arg1 :: Version) = Apply (Apply (TFHelper_6989586621679359061Sym0 :: TyFun Version (Version ~> Bool) -> Type) arg) arg1
type (arg :: Version) >= (arg1 :: Version) Source #
Instance details Defined in Wire.API.Federation.Version type (arg :: Version) >= (arg1 :: Version) = Apply (Apply (TFHelper_6989586621679359077Sym0 :: TyFun Version (Version ~> Bool) -> Type) arg) arg1
type Compare (a1 :: Version) (a2 :: Version) Source #
Instance details Defined in Wire.API.Federation.Version type Compare (a1 :: Version) (a2 :: Version)
type Max (arg :: Version) (arg1 :: Version) Source #
Instance details Defined in Wire.API.Federation.Version type Max (arg :: Version) (arg1 :: Version) = Apply (Apply (Max_6989586621679359093Sym0 :: TyFun Version (Version ~> Version) -> Type) arg) arg1
type Min (arg :: Version) (arg1 :: Version) Source #
Instance details Defined in Wire.API.Federation.Version type Min (arg :: Version) (arg1 :: Version) = Apply (Apply (Min_6989586621679359109Sym0 :: TyFun Version (Version ~> Version) -> Type) arg) arg1

type family V0Sym0 :: Version where ... Source #

Equations

V0Sym0 = 'V0

type family V1Sym0 :: Version where ... Source #

Equations

V1Sym0 = 'V1

type family V2Sym0 :: Version where ... Source #

Equations

V2Sym0 = 'V2

intToVersion :: Int -> Maybe Version Source #

versionInt :: Version -> Int Source #

versionText :: Version -> Text Source #

supportedVersions :: Set Version Source #

data VersionInfo Source #

Constructors

VersionInfo
Fields vinfoSupported :: [Int]

Instances

Instances details

FromJSON VersionInfo Source #
Instance details Defined in Wire.API.Federation.Version Methods parseJSON :: Value -> Parser VersionInfo Source # parseJSONList :: Value -> Parser [VersionInfo] Source #
ToJSON VersionInfo Source #
Instance details Defined in Wire.API.Federation.Version Methods toJSON :: VersionInfo -> Value Source # toEncoding :: VersionInfo -> Encoding Source # toJSONList :: [VersionInfo] -> Value Source # toEncodingList :: [VersionInfo] -> Encoding Source #
ToSchema VersionInfo Source #
Instance details Defined in Wire.API.Federation.Version Methods declareNamedSchema :: Proxy VersionInfo -> Declare (Definitions Schema) NamedSchema Source #
ToSchema VersionInfo Source #
Instance details Defined in Wire.API.Federation.Version Methods schema :: ValueSchema NamedSwaggerDoc VersionInfo Source #

versionInfo :: VersionInfo Source #

VersionRange

data VersionUpperBound Source #

The upper bound of a version range.

The order of constructors here makes the Unbounded value maximum in the generated lexicographic ordering.

Constructors

VersionUpperBound Version
Unbounded

Instances

Instances details

Show VersionUpperBound Source #
Instance details Defined in Wire.API.Federation.Version Methods showsPrec :: Int -> VersionUpperBound -> ShowS # show :: VersionUpperBound -> String # showList :: [VersionUpperBound] -> ShowS #
Eq VersionUpperBound Source #
Instance details Defined in Wire.API.Federation.Version Methods (==) :: VersionUpperBound -> VersionUpperBound -> Bool # (/=) :: VersionUpperBound -> VersionUpperBound -> Bool #
Ord VersionUpperBound Source #
Instance details Defined in Wire.API.Federation.Version Methods compare :: VersionUpperBound -> VersionUpperBound -> Ordering # (<) :: VersionUpperBound -> VersionUpperBound -> Bool # (<=) :: VersionUpperBound -> VersionUpperBound -> Bool # (>) :: VersionUpperBound -> VersionUpperBound -> Bool # (>=) :: VersionUpperBound -> VersionUpperBound -> Bool # max :: VersionUpperBound -> VersionUpperBound -> VersionUpperBound # min :: VersionUpperBound -> VersionUpperBound -> VersionUpperBound #

data VersionRange Source #

Constructors

VersionRange
Fields _fromVersion :: Version _toVersionExcl :: VersionUpperBound

Instances

Instances details

FromJSON VersionRange Source #
Instance details Defined in Wire.API.Federation.Version Methods parseJSON :: Value -> Parser VersionRange Source # parseJSONList :: Value -> Parser [VersionRange] Source #
ToJSON VersionRange Source #
Instance details Defined in Wire.API.Federation.Version Methods toJSON :: VersionRange -> Value Source # toEncoding :: VersionRange -> Encoding Source # toJSONList :: [VersionRange] -> Value Source # toEncodingList :: [VersionRange] -> Encoding Source #
Semigroup VersionRange Source #	The semigroup instance of VersionRange is intersection.
Instance details Defined in Wire.API.Federation.Version Methods (<>) :: VersionRange -> VersionRange -> VersionRange # sconcat :: NonEmpty VersionRange -> VersionRange # stimes :: Integral b => b -> VersionRange -> VersionRange #
Show VersionRange Source #
Instance details Defined in Wire.API.Federation.Version Methods showsPrec :: Int -> VersionRange -> ShowS # show :: VersionRange -> String # showList :: [VersionRange] -> ShowS #
Eq VersionRange Source #
Instance details Defined in Wire.API.Federation.Version Methods (==) :: VersionRange -> VersionRange -> Bool # (/=) :: VersionRange -> VersionRange -> Bool #
Ord VersionRange Source #
Instance details Defined in Wire.API.Federation.Version Methods compare :: VersionRange -> VersionRange -> Ordering # (<) :: VersionRange -> VersionRange -> Bool # (<=) :: VersionRange -> VersionRange -> Bool # (>) :: VersionRange -> VersionRange -> Bool # (>=) :: VersionRange -> VersionRange -> Bool # max :: VersionRange -> VersionRange -> VersionRange # min :: VersionRange -> VersionRange -> VersionRange #
ToSchema VersionRange Source #
Instance details Defined in Wire.API.Federation.Version Methods schema :: ValueSchema NamedSwaggerDoc VersionRange Source #

allVersions :: VersionRange Source #

latestCommonVersion :: Foldable f => VersionRange -> f Int -> Maybe Version Source #

For a version range of a local backend and for a set of versions that a remote backend supports, compute the newest version supported by both. The remote versions are given as integers as the range of versions supported by the remote backend can include a version unknown to the local backend. If there is no version in common, the return value is Nothing.

rangeFromVersion :: Version -> VersionRange Source #

rangeUntilVersion :: Version -> VersionRange Source #