Copyright	© Clément Delafargue 2021
License	BSD-3-Clause
Maintainer	clement@delafargue.name
Safe Haskell	Safe-Inferred
Language	Haskell2010

Auth.Biscuit.Symbols

Description

Symbol management logic for biscuit serialization

Synopsis

data Symbols
data BlockSymbols
data ReverseSymbols
newtype SymbolRef = SymbolRef {
- getSymbolRef :: Int64
}
newtype PublicKeyRef = PublicKeyRef {
- getPublicKeyRef :: Int64
}
getSymbol :: Symbols -> SymbolRef -> Either String Text
getPublicKey' :: Symbols -> PublicKeyRef -> Either String PublicKey
addSymbols :: Symbols -> Set Text -> Set PublicKey -> BlockSymbols
addFromBlock :: Symbols -> BlockSymbols -> Symbols
registerNewSymbols :: [Text] -> Symbols -> Symbols
registerNewPublicKeys :: [PublicKey] -> Symbols -> Symbols
reverseSymbols :: Symbols -> ReverseSymbols
getSymbolList :: BlockSymbols -> [Text]
getPkList :: BlockSymbols -> [PublicKey]
getPkTable :: Symbols -> [PublicKey]
getSymbolCode :: ReverseSymbols -> Text -> SymbolRef
getPublicKeyCode :: ReverseSymbols -> PublicKey -> Int64
newSymbolTable :: Symbols

Documentation

data Symbols Source #

Instances

Instances details

Show Symbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods showsPrec :: Int -> Symbols -> ShowS # show :: Symbols -> String # showList :: [Symbols] -> ShowS #
Eq Symbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods (==) :: Symbols -> Symbols -> Bool # (/=) :: Symbols -> Symbols -> Bool #

data BlockSymbols Source #

Instances

Instances details

Semigroup BlockSymbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods (<>) :: BlockSymbols -> BlockSymbols -> BlockSymbols # sconcat :: NonEmpty BlockSymbols -> BlockSymbols # stimes :: Integral b => b -> BlockSymbols -> BlockSymbols #
Show BlockSymbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods showsPrec :: Int -> BlockSymbols -> ShowS # show :: BlockSymbols -> String # showList :: [BlockSymbols] -> ShowS #
Eq BlockSymbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods (==) :: BlockSymbols -> BlockSymbols -> Bool # (/=) :: BlockSymbols -> BlockSymbols -> Bool #

data ReverseSymbols Source #

Instances

Instances details

Semigroup ReverseSymbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods (<>) :: ReverseSymbols -> ReverseSymbols -> ReverseSymbols # sconcat :: NonEmpty ReverseSymbols -> ReverseSymbols # stimes :: Integral b => b -> ReverseSymbols -> ReverseSymbols #
Show ReverseSymbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods showsPrec :: Int -> ReverseSymbols -> ShowS # show :: ReverseSymbols -> String # showList :: [ReverseSymbols] -> ShowS #
Eq ReverseSymbols Source #
Instance details Defined in Auth.Biscuit.Symbols Methods (==) :: ReverseSymbols -> ReverseSymbols -> Bool # (/=) :: ReverseSymbols -> ReverseSymbols -> Bool #

newtype SymbolRef Source #

Constructors

SymbolRef
Fields getSymbolRef :: Int64

Instances

Instances details

Enum SymbolRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods succ :: SymbolRef -> SymbolRef # pred :: SymbolRef -> SymbolRef # toEnum :: Int -> SymbolRef # fromEnum :: SymbolRef -> Int # enumFrom :: SymbolRef -> [SymbolRef] # enumFromThen :: SymbolRef -> SymbolRef -> [SymbolRef] # enumFromTo :: SymbolRef -> SymbolRef -> [SymbolRef] # enumFromThenTo :: SymbolRef -> SymbolRef -> SymbolRef -> [SymbolRef] #
Show SymbolRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods showsPrec :: Int -> SymbolRef -> ShowS # show :: SymbolRef -> String # showList :: [SymbolRef] -> ShowS #
Eq SymbolRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods (==) :: SymbolRef -> SymbolRef -> Bool # (/=) :: SymbolRef -> SymbolRef -> Bool #
Ord SymbolRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods compare :: SymbolRef -> SymbolRef -> Ordering # (<) :: SymbolRef -> SymbolRef -> Bool # (<=) :: SymbolRef -> SymbolRef -> Bool # (>) :: SymbolRef -> SymbolRef -> Bool # (>=) :: SymbolRef -> SymbolRef -> Bool # max :: SymbolRef -> SymbolRef -> SymbolRef # min :: SymbolRef -> SymbolRef -> SymbolRef #

newtype PublicKeyRef Source #

Constructors

PublicKeyRef
Fields getPublicKeyRef :: Int64

Instances

Instances details

Enum PublicKeyRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods succ :: PublicKeyRef -> PublicKeyRef # pred :: PublicKeyRef -> PublicKeyRef # toEnum :: Int -> PublicKeyRef # fromEnum :: PublicKeyRef -> Int # enumFrom :: PublicKeyRef -> [PublicKeyRef] # enumFromThen :: PublicKeyRef -> PublicKeyRef -> [PublicKeyRef] # enumFromTo :: PublicKeyRef -> PublicKeyRef -> [PublicKeyRef] # enumFromThenTo :: PublicKeyRef -> PublicKeyRef -> PublicKeyRef -> [PublicKeyRef] #
Show PublicKeyRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods showsPrec :: Int -> PublicKeyRef -> ShowS # show :: PublicKeyRef -> String # showList :: [PublicKeyRef] -> ShowS #
Eq PublicKeyRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods (==) :: PublicKeyRef -> PublicKeyRef -> Bool # (/=) :: PublicKeyRef -> PublicKeyRef -> Bool #
Ord PublicKeyRef Source #
Instance details Defined in Auth.Biscuit.Symbols Methods compare :: PublicKeyRef -> PublicKeyRef -> Ordering # (<) :: PublicKeyRef -> PublicKeyRef -> Bool # (<=) :: PublicKeyRef -> PublicKeyRef -> Bool # (>) :: PublicKeyRef -> PublicKeyRef -> Bool # (>=) :: PublicKeyRef -> PublicKeyRef -> Bool # max :: PublicKeyRef -> PublicKeyRef -> PublicKeyRef # min :: PublicKeyRef -> PublicKeyRef -> PublicKeyRef #

getSymbol :: Symbols -> SymbolRef -> Either String Text Source #

getPublicKey' :: Symbols -> PublicKeyRef -> Either String PublicKey Source #

addSymbols :: Symbols -> Set Text -> Set PublicKey -> BlockSymbols Source #

Given already existing symbols and a set of symbols used in a block, compute the symbol table carried by this specific block

addFromBlock :: Symbols -> BlockSymbols -> Symbols Source #

Given the symbol table of a protobuf block, update the provided symbol table

registerNewSymbols :: [Text] -> Symbols -> Symbols Source #

registerNewPublicKeys :: [PublicKey] -> Symbols -> Symbols Source #

reverseSymbols :: Symbols -> ReverseSymbols Source #

Reverse a symbol table

getSymbolList :: BlockSymbols -> [Text] Source #

getPkList :: BlockSymbols -> [PublicKey] Source #

getPkTable :: Symbols -> [PublicKey] Source #

getSymbolCode :: ReverseSymbols -> Text -> SymbolRef Source #

Given a reverse symbol table (symbol refs indexed by their textual representation), turn textual representations into symbol refs. This function is partial, the reverse table is guaranteed to contain the expected textual symbols.

getPublicKeyCode :: ReverseSymbols -> PublicKey -> Int64 Source #

newSymbolTable :: Symbols Source #