Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Share.Types

Description

Types related to Share and Codeservers.

Synopsis

data CodeserverURI = CodeserverURI {
- codeserverScheme :: Scheme
- codeserverUserInfo :: String
- codeserverRegName :: String
- codeserverPort :: Maybe Int
- codeserverPath :: [String]
}
newtype CodeserverId = CodeserverId {
- codeserverId :: Text
}
data Scheme
- = Http
- | Https
codeserverFromURI :: URI -> Maybe CodeserverURI
codeserverIdFromURI :: URI -> Either Text CodeserverId
codeserverToURI :: CodeserverURI -> URI
codeserverIdFromCodeserverURI :: CodeserverURI -> CodeserverId
codeserverBaseURL :: CodeserverURI -> BaseUrl

Documentation

data CodeserverURI Source #

This type is expanded out into all of its fields because we require certain pieces which are optional in a URI, and also to make it more typesafe to eventually convert into a BaseURL for servant clients.

Constructors

CodeserverURI
Fields codeserverScheme :: Scheme codeserverUserInfo :: String codeserverRegName :: String codeserverPort :: Maybe Int codeserverPath :: [String]

Instances

Instances details

Show CodeserverURI Source #
Instance details Defined in Unison.Share.Types Methods showsPrec :: Int -> CodeserverURI -> ShowS # show :: CodeserverURI -> String # showList :: [CodeserverURI] -> ShowS #
Eq CodeserverURI Source #
Instance details Defined in Unison.Share.Types Methods (==) :: CodeserverURI -> CodeserverURI -> Bool # (/=) :: CodeserverURI -> CodeserverURI -> Bool #
Ord CodeserverURI Source #
Instance details Defined in Unison.Share.Types Methods compare :: CodeserverURI -> CodeserverURI -> Ordering # (<) :: CodeserverURI -> CodeserverURI -> Bool # (<=) :: CodeserverURI -> CodeserverURI -> Bool # (>) :: CodeserverURI -> CodeserverURI -> Bool # (>=) :: CodeserverURI -> CodeserverURI -> Bool # max :: CodeserverURI -> CodeserverURI -> CodeserverURI # min :: CodeserverURI -> CodeserverURI -> CodeserverURI #

newtype CodeserverId Source #

This is distinct from the codeserver URI in that we store credentials by a normalized ID, since it's much easier to look up that way than from an arbitrary path. We may wish to use explicitly named configurations in the future. This currently uses a stringified uriAuthority.

Constructors

CodeserverId
Fields codeserverId :: Text

Instances

Instances details

FromJSON CodeserverId Source #
Instance details Defined in Unison.Share.Types Methods parseJSON :: Value -> Parser CodeserverId # parseJSONList :: Value -> Parser [CodeserverId] #
FromJSONKey CodeserverId Source #
Instance details Defined in Unison.Share.Types Methods fromJSONKey :: FromJSONKeyFunction CodeserverId # fromJSONKeyList :: FromJSONKeyFunction [CodeserverId] #
ToJSON CodeserverId Source #
Instance details Defined in Unison.Share.Types Methods toJSON :: CodeserverId -> Value # toEncoding :: CodeserverId -> Encoding # toJSONList :: [CodeserverId] -> Value # toEncodingList :: [CodeserverId] -> Encoding #
ToJSONKey CodeserverId Source #
Instance details Defined in Unison.Share.Types Methods toJSONKey :: ToJSONKeyFunction CodeserverId # toJSONKeyList :: ToJSONKeyFunction [CodeserverId] #
Show CodeserverId Source #
Instance details Defined in Unison.Share.Types Methods showsPrec :: Int -> CodeserverId -> ShowS # show :: CodeserverId -> String # showList :: [CodeserverId] -> ShowS #
Eq CodeserverId Source #
Instance details Defined in Unison.Share.Types Methods (==) :: CodeserverId -> CodeserverId -> Bool # (/=) :: CodeserverId -> CodeserverId -> Bool #
Ord CodeserverId Source #
Instance details Defined in Unison.Share.Types Methods compare :: CodeserverId -> CodeserverId -> Ordering # (<) :: CodeserverId -> CodeserverId -> Bool # (<=) :: CodeserverId -> CodeserverId -> Bool # (>) :: CodeserverId -> CodeserverId -> Bool # (>=) :: CodeserverId -> CodeserverId -> Bool # max :: CodeserverId -> CodeserverId -> CodeserverId # min :: CodeserverId -> CodeserverId -> CodeserverId #

data Scheme Source #

Constructors

Http
Https

Instances

Instances details

Show Scheme Source #
Instance details Defined in Unison.Share.Types Methods showsPrec :: Int -> Scheme -> ShowS # show :: Scheme -> String # showList :: [Scheme] -> ShowS #
Eq Scheme Source #
Instance details Defined in Unison.Share.Types Methods (==) :: Scheme -> Scheme -> Bool # (/=) :: Scheme -> Scheme -> Bool #
Ord Scheme Source #
Instance details Defined in Unison.Share.Types Methods compare :: Scheme -> Scheme -> Ordering # (<) :: Scheme -> Scheme -> Bool # (<=) :: Scheme -> Scheme -> Bool # (>) :: Scheme -> Scheme -> Bool # (>=) :: Scheme -> Scheme -> Bool # max :: Scheme -> Scheme -> Scheme # min :: Scheme -> Scheme -> Scheme #

codeserverFromURI :: URI -> Maybe CodeserverURI Source #

>>> import Data.Maybe (fromJust)
>>> codeserverFromURI . fromJust $ parseURI "http://localhost:8080"
Just http://localhost:8080
>>> codeserverFromURI . fromJust $ parseURI "http://localhost:80"
Just http://localhost:80
>>> codeserverFromURI . fromJust $ parseURI "https://share.unison-lang.org/api"
Just https://share.unison-lang.org/api
>>> codeserverFromURI . fromJust $ parseURI "http://share.unison-lang.org/api"
Just http://share.unison-lang.org/api

codeserverIdFromURI :: URI -> Either Text CodeserverId Source #

Gets the part of the CodeserverURI that we use for identifying that codeserver in credentials files.

>>> import Data.Maybe (fromJust)
>>> import Network.URI (parseURI)
>>> codeserverIdFromURI (fromJust $ parseURI "http://localhost:5424/api")
>>> codeserverIdFromURI (fromJust $ parseURI "https://share.unison-lang.org/api")
Right "localhost:5424"
Right "share.unison-lang.org"

codeserverToURI :: CodeserverURI -> URI Source #

codeserverIdFromCodeserverURI :: CodeserverURI -> CodeserverId Source #

Gets the CodeserverId for a given CodeserverURI

codeserverBaseURL :: CodeserverURI -> BaseUrl Source #

Builds a servant-compatible BaseUrl for a given CodeserverURI.