Safe Haskell	None
Language	Haskell2010

Octane.Type.RemoteId

Synopsis

Documentation

data RemoteId Source #

A player's canonical remote ID. This is the best way to uniquely identify players

Constructors

RemotePlayStationId PlayStationId
RemoteSplitscreenId SplitscreenId
RemoteSteamId SteamId
RemoteXboxId XboxId

Instances

Eq RemoteId Source #
Methods (==) :: RemoteId -> RemoteId -> Bool # (/=) :: RemoteId -> RemoteId -> Bool #
Show RemoteId Source #
Methods showsPrec :: Int -> RemoteId -> ShowS # show :: RemoteId -> String # showList :: [RemoteId] -> ShowS #
Generic RemoteId Source #
Associated Types type Rep RemoteId :: * -> * # Methods from :: RemoteId -> Rep RemoteId x # to :: Rep RemoteId x -> RemoteId #
ToJSON RemoteId Source #	Encodes the remote ID as an object with Type and Value keys. `>>>` `Aeson.encode (RemoteSteamId (SteamId 1))`"{\"Value\":1,\"Type\":\"Steam\"}"
Methods toJSON :: RemoteId -> Value # toEncoding :: RemoteId -> Encoding # toJSONList :: [RemoteId] -> Value # toEncodingList :: [RemoteId] -> Encoding #
NFData RemoteId Source #
Methods rnf :: RemoteId -> () #
type Rep RemoteId Source #
type Rep RemoteId = D1 (MetaData "RemoteId" "Octane.Type.RemoteId" "octane-0.13.4-DJqUOnYo1oADH9HuNkv3YY" False) ((:+:) ((:+:) (C1 (MetaCons "RemotePlayStationId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 PlayStationId))) (C1 (MetaCons "RemoteSplitscreenId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 SplitscreenId)))) ((:+:) (C1 (MetaCons "RemoteSteamId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 SteamId))) (C1 (MetaCons "RemoteXboxId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 XboxId)))))

newtype SteamId Source #

Constructors

SteamId Word64

Instances

Eq SteamId Source #
Methods (==) :: SteamId -> SteamId -> Bool # (/=) :: SteamId -> SteamId -> Bool #
Show SteamId Source #
Methods showsPrec :: Int -> SteamId -> ShowS # show :: SteamId -> String # showList :: [SteamId] -> ShowS #
Generic SteamId Source #
Associated Types type Rep SteamId :: * -> * # Methods from :: SteamId -> Rep SteamId x # to :: Rep SteamId x -> SteamId #
ToJSON SteamId Source #	Encoded directly as a number. `>>>` `Aeson.encode (SteamId 1)`"1"
Methods toJSON :: SteamId -> Value # toEncoding :: SteamId -> Encoding # toJSONList :: [SteamId] -> Value # toEncodingList :: [SteamId] -> Encoding #
BinaryBit SteamId Source #	Stored as a plain `Word64`. `>>>` `Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x80\x00\x00\x00\x00\x00\x00\x00" :: SteamId`SteamId {unpackSteamId = 0x0000000000000001} `>>>` `Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (SteamId 1)))`"\128\NUL\NUL\NUL\NUL\NUL\NUL\NUL"
Methods putBits :: Int -> SteamId -> BitPut () # getBits :: Int -> BitGet SteamId #
NFData SteamId Source #
Methods rnf :: SteamId -> () #
type Rep SteamId Source #
type Rep SteamId = D1 (MetaData "SteamId" "Octane.Type.RemoteId" "octane-0.13.4-DJqUOnYo1oADH9HuNkv3YY" True) (C1 (MetaCons "SteamId" PrefixI True) (S1 (MetaSel (Just Symbol "unpackSteamId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)))

data PlayStationId Source #

Constructors

PlayStationId Text ByteString

Instances

Eq PlayStationId Source #
Methods (==) :: PlayStationId -> PlayStationId -> Bool # (/=) :: PlayStationId -> PlayStationId -> Bool #
Show PlayStationId Source #
Methods showsPrec :: Int -> PlayStationId -> ShowS # show :: PlayStationId -> String # showList :: [PlayStationId] -> ShowS #
Generic PlayStationId Source #
Associated Types type Rep PlayStationId :: * -> * # Methods from :: PlayStationId -> Rep PlayStationId x # to :: Rep PlayStationId x -> PlayStationId #
ToJSON PlayStationId Source #	`>>>` `Aeson.encode (PlayStationId "A" "B")`"{\"Unknown\":\"0x42\",\"Name\":\"A\"}"
Methods toJSON :: PlayStationId -> Value # toEncoding :: PlayStationId -> Encoding # toJSONList :: [PlayStationId] -> Value # toEncodingList :: [PlayStationId] -> Encoding #
BinaryBit PlayStationId Source #	Each part is stored as exactly 16 bits. `>>>` `Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x42\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80" :: PlayStationId`PlayStationId {playStationName = "B", playStationUnknown = "\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\SOH"} `>>>` `Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (PlayStationId "A" "\x01")))`"\130\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\NUL\128"
Methods putBits :: Int -> PlayStationId -> BitPut () # getBits :: Int -> BitGet PlayStationId #
NFData PlayStationId Source #
Methods rnf :: PlayStationId -> () #
type Rep PlayStationId Source #
type Rep PlayStationId = D1 (MetaData "PlayStationId" "Octane.Type.RemoteId" "octane-0.13.4-DJqUOnYo1oADH9HuNkv3YY" False) (C1 (MetaCons "PlayStationId" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "playStationName") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "playStationUnknown") NoSourceUnpackedness NoSourceStrictness DecidedStrict) (Rec0 ByteString))))

newtype SplitscreenId Source #

Constructors

SplitscreenId (Maybe Int)

Instances

Eq SplitscreenId Source #
Methods (==) :: SplitscreenId -> SplitscreenId -> Bool # (/=) :: SplitscreenId -> SplitscreenId -> Bool #
Show SplitscreenId Source #
Methods showsPrec :: Int -> SplitscreenId -> ShowS # show :: SplitscreenId -> String # showList :: [SplitscreenId] -> ShowS #
Generic SplitscreenId Source #
Associated Types type Rep SplitscreenId :: * -> * # Methods from :: SplitscreenId -> Rep SplitscreenId x # to :: Rep SplitscreenId x -> SplitscreenId #
ToJSON SplitscreenId Source #	Encoded as an optional number. `>>>` `Aeson.encode (SplitscreenId Nothing)`"null" `>>>` `Aeson.encode (SplitscreenId (Just 0))`"0"
Methods toJSON :: SplitscreenId -> Value # toEncoding :: SplitscreenId -> Encoding # toJSONList :: [SplitscreenId] -> Value # toEncodingList :: [SplitscreenId] -> Encoding #
BinaryBit SplitscreenId Source #	Stored as a bare byte string. `>>>` `Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x00\x00\x00" :: SplitscreenId`SplitscreenId {unpackSplitscreenId = Just 0} `>>>` `Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (SplitscreenId (Just 0))))`"\NUL\NUL\NUL"
Methods putBits :: Int -> SplitscreenId -> BitPut () # getBits :: Int -> BitGet SplitscreenId #
NFData SplitscreenId Source #
Methods rnf :: SplitscreenId -> () #
type Rep SplitscreenId Source #
type Rep SplitscreenId = D1 (MetaData "SplitscreenId" "Octane.Type.RemoteId" "octane-0.13.4-DJqUOnYo1oADH9HuNkv3YY" True) (C1 (MetaCons "SplitscreenId" PrefixI True) (S1 (MetaSel (Just Symbol "unpackSplitscreenId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))

newtype XboxId Source #

Constructors

XboxId Word64

Instances

Eq XboxId Source #
Methods (==) :: XboxId -> XboxId -> Bool # (/=) :: XboxId -> XboxId -> Bool #
Show XboxId Source #
Methods showsPrec :: Int -> XboxId -> ShowS # show :: XboxId -> String # showList :: [XboxId] -> ShowS #
Generic XboxId Source #
Associated Types type Rep XboxId :: * -> * # Methods from :: XboxId -> Rep XboxId x # to :: Rep XboxId x -> XboxId #
ToJSON XboxId Source #	Encoded directly as a number. `>>>` `Aeson.encode (XboxId 1)`"1"
Methods toJSON :: XboxId -> Value # toEncoding :: XboxId -> Encoding # toJSONList :: [XboxId] -> Value # toEncodingList :: [XboxId] -> Encoding #
BinaryBit XboxId Source #	Stored as a plain `Word64`. `>>>` `Binary.runGet (BinaryBit.runBitGet (BinaryBit.getBits 0)) "\x80\x00\x00\x00\x00\x00\x00\x00" :: XboxId`XboxId {unpackXboxId = 0x0000000000000001} `>>>` `Binary.runPut (BinaryBit.runBitPut (BinaryBit.putBits 0 (XboxId 1)))`"\128\NUL\NUL\NUL\NUL\NUL\NUL\NUL"
Methods putBits :: Int -> XboxId -> BitPut () # getBits :: Int -> BitGet XboxId #
NFData XboxId Source #
Methods rnf :: XboxId -> () #
type Rep XboxId Source #
type Rep XboxId = D1 (MetaData "XboxId" "Octane.Type.RemoteId" "octane-0.13.4-DJqUOnYo1oADH9HuNkv3YY" True) (C1 (MetaCons "XboxId" PrefixI True) (S1 (MetaSel (Just Symbol "unpackXboxId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word64)))