Network.Gemini.Capsule.Types

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Types

data GemURL

Gemini URL

Constructors

GemURL

Fields

• gemHost :: String

  The host part of the authority section, e.g.: "example.com"

• gemPort :: Maybe Word32

  The port number (if supplied)

• gemPath :: [String]

  The decoded path segments

• gemQuery :: Maybe String

  The decoded request query (if supplied)

Instances

Show GemURL

Defined in Network.Gemini.Capsule.Types

Methods

showsPrec :: Int -> GemURL -> ShowS

show :: GemURL -> String

showList :: [GemURL] -> ShowS

Eq GemURL

Defined in Network.Gemini.Capsule.Types

Methods

(==) :: GemURL -> GemURL -> Bool

(/=) :: GemURL -> GemURL -> Bool

data GemRequest

Describes a Gemini request

Constructors

GemRequest

Fields

• reqURL :: GemURL

  The URL being requested

• reqCert :: Maybe Certificate

  The client certificate (if available)

Instances

Show GemRequest

Defined in Network.Gemini.Capsule.Types

Methods

showsPrec :: Int -> GemRequest -> ShowS

show :: GemRequest -> String

showList :: [GemRequest] -> ShowS

Eq GemRequest

Defined in Network.Gemini.Capsule.Types

Methods

(==) :: GemRequest -> GemRequest -> Bool

(/=) :: GemRequest -> GemRequest -> Bool

data GemResponse

Describes a response to a Gemini request

Constructors

GemResponse

Fields

• respStatus :: Word8

  The response status code

• respMeta :: String

  The response metadata

• respBody :: Maybe ByteString

  The response body

Instances

Show GemResponse

Defined in Network.Gemini.Capsule.Types

Methods

showsPrec :: Int -> GemResponse -> ShowS

show :: GemResponse -> String

showList :: [GemResponse] -> ShowS

Eq GemResponse

Defined in Network.Gemini.Capsule.Types

Methods

(==) :: GemResponse -> GemResponse -> Bool

(/=) :: GemResponse -> GemResponse -> Bool

type GemHandler = GemRequest -> IO GemResponse

Handles a GemRequest to produce a GemResponse

data GemCapSettings

The settings required to set up a Gemini capsule

Constructors

GemCapSettings

Fields

• capConnections :: Int

  Number of simultaneous connections allowed

• capPort :: Word16

  The capsule port number

• capCert :: FilePath

  The path to the TLS certificate

• capCertChain :: [FilePath]

  The paths to the chain certificates

• capKey :: FilePath

  The path to the private key

Instances

Show GemCapSettings

Defined in Network.Gemini.Capsule.Types

Methods

showsPrec :: Int -> GemCapSettings -> ShowS

show :: GemCapSettings -> String

showList :: [GemCapSettings] -> ShowS

Eq GemCapSettings

Defined in Network.Gemini.Capsule.Types

Methods

(==) :: GemCapSettings -> GemCapSettings -> Bool

(/=) :: GemCapSettings -> GemCapSettings -> Bool

Constructors

newGemURL

Arguments

:: String

The hostname

-> GemURL

Builds a new GemURL

newGemRequest

Arguments

:: GemURL

The request URL

-> GemRequest

Builds a GemRequest

newGemResponse :: GemResponse

Builds a GemResponse

newGemCapSettings

Arguments

:: FilePath

Path to the server certificate

-> FilePath

Path to the private key

-> GemCapSettings

Builds a reasonable set of server settings.