Network.RTorrent.Command.Internals

Documentation

data a :*: b infixr 6

A strict 2-tuple for easy combining of commands.

Constructors

(:*:) !a !b infixr 6

Instances

(Show a, Show b) => Show ((:*:) a b)

(NFData a, NFData b) => NFData ((:*:) a b)

(Command a, Command b) => Command ((:*:) a b)

type Ret ((:*:) a b) = (:*:) (Ret a) (Ret b)

class Command a where

A typeclass for commands that can be send to RTorrent.

Minimal complete definition

commandCall, commandValue

Associated Types

type Ret a

Return type of the command.

Methods

commandCall :: a -> RTMethodCall

Construct a request.

commandValue :: (Applicative m, Monad m) => a -> Value -> m (Ret a)

Parse the resulting value.

levels :: a -> Int

Instances

Command AnyCommand

Command a => Command [a]

Command (Global a)

(Command a, Command b) => Command ((:*:) a b)

Command (AllAction i a)

XmlRpcType i => Command (Action i a)

data AnyCommand where

Existential wrapper for any command.

Commands wrapped in AnyCommand won't parse their results.

AnyCommand can be used when you want to call multiple commands but don't care about their return values.

Constructors

AnyCommand :: Command a => a -> AnyCommand

Instances

Command AnyCommand

type Ret AnyCommand = Value

newtype RTMethodCall

A newtype wrapper for method calls.

You shouldn't directly use the constructor if you don't know what you are doing.

Constructors

RTMethodCall Value

Instances

Show RTMethodCall

runRTMethodCall :: RTMethodCall -> Value

mkRTMethodCall

Arguments

:: String

The name of the method (i.e. get_up_rate)

-> [Value]

List of parameters

-> RTMethodCall

Make a command that should be used when defining commandCall.

parseSingle :: (Monad m, XmlRpcType a) => Value -> m a

Parse a value wrapped in two singleton arrays.

getArray :: Monad m => Value -> m [Value]

getArray' :: Value -> [Value]

single :: Monad m => Value -> m Value

Extract a value from a singleton array.

decodeUtf8 :: String -> String