syncthing-hs-0.1.0.0: Haskell bindings for the Syncthing REST API

Safe HaskellNone
LanguageHaskell2010

Network.Syncthing.Internal.Types

Synopsis

Documentation

data CacheEntry

Represents an entry in the discovery cache.

Constructors

CacheEntry 

Instances

data Config

The current configuration data structure.

Instances

Eq Config 
Show Config 
ToJSON Config 
FromJSON Config 

data DeviceConfig

Device specific configuration information.

data VersioningConfig

Information about versioning.

Constructors

VersioningConfig 

Fields

getType :: Text
 
getParams :: Map Text Text
 

data GuiConfig

Gui settings.

Constructors

GuiConfig 

Fields

getEnabled :: Bool
 
getApiKey :: Maybe Text
 
getGuiAddress :: Addr
 
getUser :: Text
 
getPassword :: Text
 
getUseTLS :: Bool
 

Instances

data AddressType

An address can be dynamic or static.

Constructors

Dynamic 
Address Addr 

type Device = Text

type FolderName = Text

type Path = Text

type Host = Text

type Port = Int

type Addr = (Host, Maybe Port)

defaultFolder :: FolderName

The default folder name.

newtype Completion

Constructors

Completion 

Fields

getCompletion :: Int
 

Instances

data Connection

Connection information and some associated metadata.

Instances

parseIdResult :: FromJSON a => Bool -> Object -> Parser (Either DeviceError a)

data Error

An error message and its timestamp.

Constructors

Error 

Fields

getTime :: Maybe UTCTime
 
getMsg :: Text
 

Instances

Eq Error 
Show Error 
FromJSON Error 

newtype Errors

Constructors

Errors 

Fields

getErrors :: [Error]
 

Instances

Eq Errors 
Show Errors 
FromJSON Errors 

data Ignore

Contains the ignores list and a list of all compiled ignore patterns.

Constructors

Ignore 

Fields

getIgnores :: Maybe [Text]
 
getPatterns :: Maybe [Text]
 

Instances

Eq Ignore 
Show Ignore 
FromJSON Ignore 

data ModelState

The current state of activity of a folder.

Constructors

Idle 
Scanning 
Cleaning 
Syncing 

data Need

Contains lists of files which are needed by a device for becoming in sync.

Constructors

Need 

Fields

getProgress :: [Progress]
 
getQueued :: [Text]
 
getRest :: [Text]
 

Instances

Eq Need 
Show Need 
FromJSON Need 

data Progress

A file that is currently downloading.

Instances

newtype Ping

Constructors

Ping 

Fields

getPing :: Text
 

Instances

Eq Ping 
Show Ping 
FromJSON Ping 

newtype Sync

Constructors

Sync 

Fields

getSync :: Bool
 

Instances

Eq Sync 
Show Sync 
FromJSON Sync 

data System

Information about the system status and resource usage.

Instances

Show System 
FromJSON System 

data SystemMsg

System messages.

Instances

data Upgrade

Information about the current software version and upgrade possibilities.

Constructors

Upgrade 

Fields

getLatest :: Text
 
getNewer :: Bool
 
getRunning :: Text
 

Instances

data Version

Current Syncthing version information.

Constructors

Version 

Fields

getArch :: Text
 
getLongVersion :: Text
 
getOs :: Text
 
getVersion :: Text
 

Instances