Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Routes.MultiTablePaging.State

Synopsis

data MultiTablePagingState (name :: Symbol) tables = MultiTablePagingState {
- mtpsTable :: tables
- mtpsState :: Maybe ByteString
}
class PagingTable t where
- encodePagingTable :: t -> Word8
- decodePagingTable :: MonadFail m => Word8 -> m t

Documentation

data MultiTablePagingState (name :: Symbol) tables Source #

The state of a multi-table paginated query. It is made of a reference to the table currently being paginated, as well as an opaque token returned by Cassandra.

Constructors

MultiTablePagingState
Fields mtpsTable :: tables mtpsState :: Maybe ByteString

Instances

Instances details

ToParamSchema TeamMembersPagingState Source #
Instance details Defined in Wire.API.Team.Member Methods toParamSchema :: Proxy TeamMembersPagingState -> Schema Source #
(PagingTable tables, KnownSymbol name) => FromJSON (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods parseJSON :: Value -> Parser (MultiTablePagingState name tables) Source # parseJSONList :: Value -> Parser [MultiTablePagingState name tables] Source #
(PagingTable tables, KnownSymbol name) => ToJSON (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods toJSON :: MultiTablePagingState name tables -> Value Source # toEncoding :: MultiTablePagingState name tables -> Encoding Source # toJSONList :: [MultiTablePagingState name tables] -> Value Source # toEncodingList :: [MultiTablePagingState name tables] -> Encoding Source #
Show tables => Show (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods showsPrec :: Int -> MultiTablePagingState name tables -> ShowS # show :: MultiTablePagingState name tables -> String # showList :: [MultiTablePagingState name tables] -> ShowS #
Eq tables => Eq (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods (==) :: MultiTablePagingState name tables -> MultiTablePagingState name tables -> Bool # (/=) :: MultiTablePagingState name tables -> MultiTablePagingState name tables -> Bool #
PagingTable tables => FromHttpApiData (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods parseUrlPiece :: Text -> Either Text (MultiTablePagingState name tables) Source # parseHeader :: ByteString -> Either Text (MultiTablePagingState name tables) Source # parseQueryParam :: Text -> Either Text (MultiTablePagingState name tables) Source #
PagingTable tables => ToHttpApiData (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods toUrlPiece :: MultiTablePagingState name tables -> Text Source # toEncodedUrlPiece :: MultiTablePagingState name tables -> Builder Source # toHeader :: MultiTablePagingState name tables -> ByteString Source # toQueryParam :: MultiTablePagingState name tables -> Text Source # toEncodedQueryParam :: MultiTablePagingState name tables -> Builder Source #
(KnownSymbol name, Typeable tables, PagingTable tables) => ToSchema (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods declareNamedSchema :: Proxy (MultiTablePagingState name tables) -> Declare (Definitions Schema) NamedSchema Source #
(PagingTable tables, KnownSymbol name) => ToSchema (MultiTablePagingState name tables) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging.State Methods schema :: ValueSchema NamedSwaggerDoc (MultiTablePagingState name tables) Source #

class PagingTable t where Source #

A class for values that can be encoded with a single byte. Used to add a byte of extra information to the paging state in order to recover the table information from a paging token.

Methods

encodePagingTable :: t -> Word8 Source #

decodePagingTable :: MonadFail m => Word8 -> m t Source #

Instances

Instances details

PagingTable LocalOrRemoteTable Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods encodePagingTable :: LocalOrRemoteTable -> Word8 Source # decodePagingTable :: MonadFail m => Word8 -> m LocalOrRemoteTable Source #