Network.Syncthing.Internal

Internal constructors and helper functions. You should NOT use this module under normal circumstances!

Configuration

data SyncConfig

The Syncthing configuration for specifying the Syncthing server, authentication, the API Key etc.

Constructors

SyncConfig

Fields

server :: Server

apiKey :: Maybe Text

auth :: Maybe Auth

https :: Bool

manager :: Either ManagerSettings Manager

Instances

Show SyncConfig

pServer :: Lens' SyncConfig Server

A lens for configuring the server address. Use the ADDRESS:PORT format.

Example:

let cfg = defaultConfig & pServer .~ "192.168.0.10:8080"
syncthing cfg Get.ping

pApiKey :: Lens' SyncConfig (Maybe Text)

A lens for specifying the Syncthing API Key.

Example:

let cfg = defaultConfig & pApiKey ?~ "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
syncthing cfg Get.ping

pAuth :: Lens' SyncConfig (Maybe Auth)

A lens for configuring request authentication provided by the Wreq package (see Auth).

Example:

import qualified Network.Wreq as Wreq

let cfg = defaultConfig & pHttps .~ True
                        & pAuth  ?~ Wreq.basicAuth "user" "pass"
syncthing cfg Get.ping

pHttps :: Lens' SyncConfig Bool

A lens for enabling HTTPS usage.

Example:

let cfg = defaultConfig & pHttps .~ True
syncthing cfg Get.ping

pManager :: Lens' SyncConfig (Either ManagerSettings Manager)

A lens for specifying your own ManagerSettings/Manager. For more information, please refer to the Network.HTTP.Client package.

The Syncthing Monad

type SyncResult a = Either SyncError a

The result type of Syncthing requests.

newtype SyncM m a

The SyncM Monad represents one or multiple Syncthing requests.

Constructors

SyncM

Fields

runSyncthing :: EitherT SyncError (ReaderT SyncConfig m) a

Instances

Monad m => Monad (SyncM m)

Monad m => Functor (SyncM m)

Monad m => Applicative (SyncM m)

class Monad m => MonadSync m where

Methods

getMethod :: Options -> String -> m ByteString

postMethod :: Options -> String -> Value -> m ByteString

Instances

MonadSync IO

Use Wreq's getWith and postWith functions when running in IO

runSyncM :: SyncConfig -> SyncM m a -> m (SyncResult a)

Run Syncthing requests without error handling.

syncthingM :: MonadCatch m => SyncConfig -> SyncM m a -> m (SyncResult a)

Run Syncthing requests with error handling.

liftEither :: Monad m => EitherT SyncError (ReaderT SyncConfig m) a -> SyncM m a

liftReader :: Monad m => ReaderT SyncConfig m a -> SyncM m a

liftInner :: Monad m => m a -> SyncM m a

liftLeft :: Monad m => SyncError -> SyncM m a

liftRight :: Monad m => a -> SyncM m a

Requests

type Param = (Text, Text)

data HttpMethod

Constructors

Get

Post Value

Instances

Eq HttpMethod

Show HttpMethod

data SyncRequest

Constructors

SyncRequest

Fields

path :: String

method :: HttpMethod

params :: [Param]

Instances

Eq SyncRequest

Show SyncRequest

query :: (MonadSync m, FromJSON a) => SyncRequest -> SyncM m a

queryMaybe :: (MonadSync m, FromJSON a) => SyncRequest -> SyncM m (Maybe a)

send :: MonadSync m => SyncRequest -> SyncM m ()

get :: HttpMethod

post :: ToJSON a => a -> HttpMethod

getRequest :: SyncRequest

postRequest :: SyncRequest

Error Handling

data DeviceError

Constructors

IncorrectLength

IncorrectCheckDigit

OtherDeviceError Text

Instances

Eq DeviceError

Show DeviceError

FromJSON (Either DeviceError Device)

data SyncError

Constructors

ParseError String

NotAuthorized

CSRFError

NotFound

InvalidDeviceId DeviceError

NoSuchFolder

Instances

Eq SyncError

Show SyncError

Exception SyncError

Typeable * SyncError

syncErrHandler :: MonadThrow m => HttpException -> m (Either SyncError a)

decodeDeviceError :: Text -> DeviceError

decodeError :: ByteString -> Maybe SyncError

Utils

parseAddr :: Server -> Addr

Parse server string (SERVER:PORT) into an address type.

encodeAddr :: Addr -> Server

Generate server string.

toUTC :: String -> Maybe UTCTime

Convert time string to UTCTime type.

fromUTC :: UTCTime -> String

Generate time string from UTC.