Safe Haskell	Safe-Inferred
Language	GHC2021

Wire.API.Routes.MultiTablePaging

Synopsis

data GetMultiTablePageRequest (name :: Symbol) (tables :: Type) (max :: Nat) (def :: Nat) = GetMultiTablePageRequest {
- gmtprSize :: Range 1 max Int32
- gmtprState :: Maybe (MultiTablePagingState name tables)
}
data MultiTablePage (name :: Symbol) (resultsKey :: Symbol) (tables :: Type) a = MultiTablePage {
- mtpResults :: [a]
- mtpHasMore :: Bool
- mtpPagingState :: MultiTablePagingState name tables
}
data LocalOrRemoteTable
- = PagingLocals
- | PagingRemotes
data MultiTablePagingState (name :: Symbol) tables = MultiTablePagingState {
- mtpsTable :: tables
- mtpsState :: Maybe ByteString
}

Documentation

data GetMultiTablePageRequest (name :: Symbol) (tables :: Type) (max :: Nat) (def :: Nat) Source #

A request for a page of results from the database. Type arguments:

name Name of the resources being paginated through
tables A (usually finite) type that represent the table currently being used (must be an instance of PagingTable)
max Maximum page size
def Default page size

See ConversationPagingState for an example.

Constructors

GetMultiTablePageRequest
Fields gmtprSize :: Range 1 max Int32 gmtprState :: Maybe (MultiTablePagingState name tables)

Instances

Instances details

RequestSchemaConstraint name tables max def => FromJSON (GetMultiTablePageRequest name tables max def) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods parseJSON :: Value -> Parser (GetMultiTablePageRequest name tables max def) Source # parseJSONList :: Value -> Parser [GetMultiTablePageRequest name tables max def] Source #
RequestSchemaConstraint name tables max def => ToJSON (GetMultiTablePageRequest name tables max def) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods toJSON :: GetMultiTablePageRequest name tables max def -> Value Source # toEncoding :: GetMultiTablePageRequest name tables max def -> Encoding Source # toJSONList :: [GetMultiTablePageRequest name tables max def] -> Value Source # toEncodingList :: [GetMultiTablePageRequest name tables max def] -> Encoding Source #
Show tables => Show (GetMultiTablePageRequest name tables max def) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods showsPrec :: Int -> GetMultiTablePageRequest name tables max def -> ShowS # show :: GetMultiTablePageRequest name tables max def -> String # showList :: [GetMultiTablePageRequest name tables max def] -> ShowS #
Eq tables => Eq (GetMultiTablePageRequest name tables max def) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods (==) :: GetMultiTablePageRequest name tables max def -> GetMultiTablePageRequest name tables max def -> Bool # (/=) :: GetMultiTablePageRequest name tables max def -> GetMultiTablePageRequest name tables max def -> Bool #
(Typeable tables, RequestSchemaConstraint name tables max def) => ToSchema (GetMultiTablePageRequest name tables max def) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods declareNamedSchema :: Proxy (GetMultiTablePageRequest name tables max def) -> Declare (Definitions Schema) NamedSchema Source #
RequestSchemaConstraint name tables max def => ToSchema (GetMultiTablePageRequest name tables max def) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods schema :: ValueSchema NamedSwaggerDoc (GetMultiTablePageRequest name tables max def) Source #

data MultiTablePage (name :: Symbol) (resultsKey :: Symbol) (tables :: Type) a Source #

The result of a multi-table paginated query. Contains the list of results, a flag indicating whether there are more, and the state to pass to the next query.

Constructors

MultiTablePage
Fields mtpResults :: [a] mtpHasMore :: Bool mtpPagingState :: MultiTablePagingState name tables

Instances

Instances details

PageSchemaConstraints name resultsKey tables a => FromJSON (MultiTablePage name resultsKey tables a) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods parseJSON :: Value -> Parser (MultiTablePage name resultsKey tables a) Source # parseJSONList :: Value -> Parser [MultiTablePage name resultsKey tables a] Source #
PageSchemaConstraints name resultsKey tables a => ToJSON (MultiTablePage name resultsKey tables a) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods toJSON :: MultiTablePage name resultsKey tables a -> Value Source # toEncoding :: MultiTablePage name resultsKey tables a -> Encoding Source # toJSONList :: [MultiTablePage name resultsKey tables a] -> Value Source # toEncodingList :: [MultiTablePage name resultsKey tables a] -> Encoding Source #
(Show a, Show tables) => Show (MultiTablePage name resultsKey tables a) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods showsPrec :: Int -> MultiTablePage name resultsKey tables a -> ShowS # show :: MultiTablePage name resultsKey tables a -> String # showList :: [MultiTablePage name resultsKey tables a] -> ShowS #
(Eq a, Eq tables) => Eq (MultiTablePage name resultsKey tables a) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods (==) :: MultiTablePage name resultsKey tables a -> MultiTablePage name resultsKey tables a -> Bool # (/=) :: MultiTablePage name resultsKey tables a -> MultiTablePage name resultsKey tables a -> Bool #
(Typeable tables, Typeable a, PageSchemaConstraints name resultsKey tables a) => ToSchema (MultiTablePage name resultsKey tables a) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods declareNamedSchema :: Proxy (MultiTablePage name resultsKey tables a) -> Declare (Definitions Schema) NamedSchema Source #
(KnownSymbol resultsKey, KnownSymbol name, ToSchema a, PagingTable tables) => ToSchema (MultiTablePage name resultsKey tables a) Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods schema :: ValueSchema NamedSwaggerDoc (MultiTablePage name resultsKey tables a) Source #

data LocalOrRemoteTable Source #

A type to be used as the tables argument of GetMultiTablePageRequest when the resources being paginated through are split into local and remote.

Constructors

PagingLocals
PagingRemotes

Instances

Instances details

Show LocalOrRemoteTable Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods showsPrec :: Int -> LocalOrRemoteTable -> ShowS # show :: LocalOrRemoteTable -> String # showList :: [LocalOrRemoteTable] -> ShowS #
Eq LocalOrRemoteTable Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods (==) :: LocalOrRemoteTable -> LocalOrRemoteTable -> Bool # (/=) :: LocalOrRemoteTable -> LocalOrRemoteTable -> Bool #
PagingTable LocalOrRemoteTable Source #
Instance details Defined in Wire.API.Routes.MultiTablePaging Methods encodePagingTable :: LocalOrRemoteTable -> Word8 Source # decodePagingTable :: MonadFail m => Word8 -> m LocalOrRemoteTable Source #

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 #