Data.Rtorrent.StateFile

Documentation

overFilesIn :: FilePath -> StateMod -> IO [(FilePath, Maybe String)]

Takes a directory, StateFile modification function and does an ‘in-place’ modifications to all .rtorrent files it can find and parse in that directory. Returns the list of all file paths and any potential errors that with each.

See getRtorrentFiles for the type of exception this function can throw.

getRtorrentFiles :: FilePath -> IO [FilePath]

Gets a list of all .rtorrent files in the specified directory.

This function uses getDirectoryContents which can throw various IOExceptions. It's up to the user to catch these if they wish to do so.

withRtorrentState :: FilePath -> StateMod -> IO (Maybe String)

Attempts to read in the file at specified file path, change it with the user-supplied function and saved the file with changes.

In case the parsing fails, the result will be Just errMsg.

keepValid :: Map FilePath (Result StateFile) -> Map FilePath StateFile

Only keeps properly parsing results. Useful with parseFiles.

keepInvalid :: Map FilePath (Result StateFile) -> Map FilePath String

Similar to keepValid but instead only keeps results that failed to parse and the reason.

parseFiles :: FilePath -> IO (Map FilePath (Result StateFile))

Given a directory path, produces a Map of file paths from individual files to their parsing results.

This function uses getRtorrentFiles which can throw an IOException in case there is a problem reading the directory.

parseFile :: FilePath -> IO (Result StateFile)

Like parseFile' but throws away the FilePath: useful if we only play with single files.

parseFile' :: FilePath -> IO (FilePath, Result StateFile)

Parses a file and returns a pair of of its path and the parsing result. The path is useful if we're processing whole directories.

startTorrent :: StateMod

Sets the torrent to started state.

stopTorrent :: StateMod

Sets the torrent to stopped stated.

setTiedFile :: FilePath -> StateMod

Changes the file the torrent is tied to.

getLoadedFile :: StateFile -> FilePath

Gets a path of the loaded file.

decodeState :: ByteString -> Result StateFile

Wrapper for decode which works for StateFiles.

encodeState :: StateFile -> ByteString

Wrapper for encode which works for StateFiles.

See encodeState' for strict ByteString version.

encodeState' :: StateFile -> ByteString

Encodes a StateFile to a strict ByteString.