| Copyright | (c) 2014 Jens Thomas |
|---|---|
| License | BSD-style |
| Maintainer | jetho@gmx.de |
| Stability | experimental |
| Portability | GHC |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Syncthing.Types
Contents
Description
Type synonyms and data types.
- type Server = Text
- type Device = Text
- type FolderName = Text
- type Path = Text
- type Host = Text
- type Port = Int
- type Addr = (Host, Maybe Port)
- data CacheEntry = CacheEntry {}
- data Config = Config {}
- data AddressType
- data FolderConfig = FolderConfig {
- getId :: FolderName
- getPath :: Path
- getFolderDevices :: [Device]
- getReadOnly :: Bool
- getRescanIntervalS :: Int
- getIgnorePerms :: Bool
- getAutoNormalize :: Bool
- getVersioning :: VersioningConfig
- getCopiers :: Int
- getPullers :: Int
- getHashers :: Int
- getOrder :: Text
- getFolderInvalid :: Text
- data DeviceConfig = DeviceConfig {
- getDevice :: Device
- getDeviceName :: Text
- getAddresses :: [AddressType]
- getCompression :: Text
- getCertName :: Text
- getIntroducer :: Bool
- data VersioningConfig = VersioningConfig {}
- data GuiConfig = GuiConfig {
- getEnabled :: Bool
- getApiKey :: Maybe Text
- getGuiAddress :: Addr
- getUser :: Text
- getPassword :: Text
- getUseTLS :: Bool
- data OptionsConfig = OptionsConfig {
- getListenAddress :: [Addr]
- getGlobalAnnounceServers :: [Text]
- getGlobalAnnounceEnabled :: Bool
- getLocalAnnounceEnabled :: Bool
- getLocalAnnouncePort :: Int
- getLocalAnnounceMCAddr :: Text
- getMaxSendKbps :: Int
- getMaxRecvKbps :: Int
- getReconnectionIntervalS :: Int
- getStartBrowser :: Bool
- getUpnpEnabled :: Bool
- getUpnpLeaseMinutes :: Int
- getUpnpRenewalMinutes :: Int
- getUpnpTimeoutSeconds :: Int
- getUrAccepted :: Int
- getUrUniqueID :: Text
- getRestartOnWakeup :: Bool
- getAutoUpgradeIntervalH :: Int
- getKeepTemporariesH :: Int
- getCacheIgnoredFiles :: Bool
- getProgressUpdateIntervalS :: Int
- getSymlinksEnabled :: Bool
- getLimitBandwidthInLan :: Bool
- data Connections = Connections {}
- data Connection = Connection {
- getAt :: Maybe UTCTime
- getInBytesTotal :: Integer
- getOutBytesTotal :: Integer
- getAddress :: Addr
- getClientVersion :: Text
- data DeviceInfo = DeviceInfo {}
- data DirTree
- = Dir {
- getDirContents :: Map Text DirTree
- | File { }
- = Dir {
- data Error = Error {}
- data Ignore = Ignore {
- getIgnores :: Maybe [Text]
- getPatterns :: Maybe [Text]
- data Model = Model {
- getGlobalBytes :: Integer
- getGlobalDeleted :: Integer
- getGlobalFiles :: Integer
- getInSyncBytes :: Integer
- getInSyncFiles :: Integer
- getLocalBytes :: Integer
- getLocalDeleted :: Integer
- getLocalFiles :: Integer
- getNeedBytes :: Integer
- getNeedFiles :: Integer
- getState :: Maybe ModelState
- getStateChanged :: Maybe UTCTime
- getInvalid :: Maybe Text
- getModelVersion :: Int
- data ModelState
- data Need = Need {}
- data DBFile = DBFile {}
- data FileInfo = FileInfo {
- getName :: Text
- getFlags :: Text
- getModified :: Maybe UTCTime
- getFileVersion :: [Text]
- getLocalVersion :: Int
- getSize :: Integer
- getNumBlocks :: Maybe Int
- data FolderInfo = FolderInfo {}
- data LastFile = LastFile {
- getFileName :: Text
- getSyncedAt :: Maybe UTCTime
- data System = System {
- getAlloc :: Integer
- getCpuPercent :: Double
- getExtAnnounceOK :: Maybe (Map Server Bool)
- getGoRoutines :: Int
- getMyId :: Text
- getSys :: Integer
- getPathSeparator :: Text
- getTilde :: Text
- getUptime :: Integer
- data SystemMsg
- = Restarting
- | ShuttingDown
- | ResettingFolders
- | OtherSystemMsg Text
- data Upgrade = Upgrade {
- getLatest :: Text
- getNewer :: Bool
- getRunning :: Text
- data UsageReport = UsageReport {
- getFolderMaxFiles :: Integer
- getFolderMaxMiB :: Integer
- getLongVersionR :: Text
- getMemorySize :: Integer
- getMemoryUsageMiB :: Integer
- getNumDevices :: Int
- getNumFolders :: Int
- getPlatform :: Text
- getSHA256Perf :: Double
- getTotFiles :: Integer
- getTotMiB :: Integer
- getUniqueId :: Text
- getVersionR :: Text
- data Version = Version {
- getArch :: Text
- getLongVersion :: Text
- getOs :: Text
- getVersion :: Text
Type Synonyms
type FolderName = Text Source
Data Types
data CacheEntry Source
Represents an entry in the discovery cache.
Instances
| Eq CacheEntry | |
| Show CacheEntry | |
| FromJSON CacheEntry |
The current configuration data structure.
Constructors
| Config | |
Fields | |
data FolderConfig Source
The folder specific configuration.
Constructors
| FolderConfig | |
Fields
| |
Instances
| Eq FolderConfig | |
| Show FolderConfig | |
| ToJSON FolderConfig | |
| FromJSON FolderConfig |
data DeviceConfig Source
Device specific configuration information.
Constructors
| DeviceConfig | |
Fields
| |
Instances
| Eq DeviceConfig | |
| Show DeviceConfig | |
| ToJSON DeviceConfig | |
| FromJSON DeviceConfig |
data VersioningConfig Source
Information about versioning.
Constructors
| VersioningConfig | |
Instances
| Eq VersioningConfig | |
| Show VersioningConfig | |
| ToJSON VersioningConfig | |
| FromJSON VersioningConfig |
Gui settings.
Constructors
| GuiConfig | |
Fields
| |
data OptionsConfig Source
Various config settings.
Constructors
| OptionsConfig | |
Fields
| |
Instances
| Eq OptionsConfig | |
| Show OptionsConfig | |
| ToJSON OptionsConfig | |
| FromJSON OptionsConfig |
data Connections Source
Contains the list of current connections.
Constructors
| Connections | |
Fields | |
Instances
| Eq Connections | |
| Show Connections | |
| FromJSON Connections |
data Connection Source
Connection information and some associated metadata.
Constructors
| Connection | |
Fields
| |
Instances
| Eq Connection | |
| Show Connection | |
| FromJSON Connection |
data DeviceInfo Source
Contains information about a device.
Constructors
| DeviceInfo | |
Fields | |
Instances
| Eq DeviceInfo | |
| Show DeviceInfo | |
| FromJSON DeviceInfo |
A directory tree contains files or subdirectories.
Constructors
| Dir | |
Fields
| |
| File | |
Fields
| |
An error message and its timestamp.
Contains the ignores list and a list of all compiled ignore patterns.
Constructors
| Ignore | |
Fields
| |
Information about the current status of a folder.
Constructors
| Model | |
Fields
| |
Contains lists of files which are needed by a device for becoming in sync.
Contains data available about a given file.
All available information about a file.
Constructors
| FileInfo | |
Fields
| |
data FolderInfo Source
Contains general statistics about folders.
Constructors
| FolderInfo | |
Fields | |
Instances
| Eq FolderInfo | |
| Show FolderInfo | |
| FromJSON FolderInfo |
Information about the last synced file.
Constructors
| LastFile | |
Fields
| |
Information about the system status and resource usage.
Constructors
| System | |
Fields
| |
System messages.
Constructors
| Restarting | |
| ShuttingDown | |
| ResettingFolders | |
| OtherSystemMsg Text |
Information about the current software version and upgrade possibilities.
Constructors
| Upgrade | |
Fields
| |
data UsageReport Source
Information about the data sent in the anonymous usage report.
Constructors
| UsageReport | |
Fields
| |
Instances
| Eq UsageReport | |
| Show UsageReport | |
| FromJSON UsageReport |