Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.FileTransfer.Client.Main

Synopsis

data SendOptions = SendOptions {
- filePath :: FilePath
- outputDir :: Maybe FilePath
- numRecipients :: Int
- xftpServers :: [XFTPServerWithAuth]
- retryCount :: Int
- tempPath :: Maybe FilePath
- verbose :: Bool
}
newtype CLIError = CLIError String
xftpClientCLI :: IO ()
cliSendFile :: SendOptions -> ExceptT CLIError IO ()
cliSendFileOpts :: SendOptions -> Bool -> (Int64 -> Int64 -> IO ()) -> ExceptT CLIError IO ()
encodeWebURI :: FileDescription 'FRecipient -> ByteString
decodeWebURI :: ByteString -> Either String (ValidFileDescription 'FRecipient)
fileWebLink :: FileDescription 'FRecipient -> Maybe (ByteString, ByteString)
singleChunkSize :: Int64 -> Maybe Word32
prepareChunkSizes :: Int64 -> [Word32]
prepareChunkSpecs :: FilePath -> [Word32] -> [XFTPChunkSpec]
getChunkDigest :: XFTPChunkSpec -> IO ByteString

Documentation

Constructors

SendOptions
Fields filePath :: FilePath outputDir :: Maybe FilePath numRecipients :: Int xftpServers :: [XFTPServerWithAuth] retryCount :: Int tempPath :: Maybe FilePath verbose :: Bool

Instances details

Show SendOptions Source #
Instance details Defined in Simplex.FileTransfer.Client.Main Methods showsPrec :: Int -> SendOptions -> ShowS show :: SendOptions -> String showList :: [SendOptions] -> ShowS

Constructors

Instances details

Exception CLIError Source #
Instance details Defined in Simplex.FileTransfer.Client.Main Methods toException :: CLIError -> SomeException fromException :: SomeException -> Maybe CLIError displayException :: CLIError -> String
Show CLIError Source #
Instance details Defined in Simplex.FileTransfer.Client.Main Methods showsPrec :: Int -> CLIError -> ShowS show :: CLIError -> String showList :: [CLIError] -> ShowS
Eq CLIError Source #
Instance details Defined in Simplex.FileTransfer.Client.Main Methods (==) :: CLIError -> CLIError -> Bool (/=) :: CLIError -> CLIError -> Bool

cliSendFileOpts :: SendOptions -> Bool -> (Int64 -> Int64 -> IO ()) -> ExceptT CLIError IO () Source #

Encode file description as web-compatible URI fragment. Result is base64url(deflateRaw(YAML)), no leading #.

Decode web URI fragment to validated file description. Input is base64url-encoded DEFLATE-compressed YAML, no leading #.

Extract web link host and URI fragment from a file description. Returns (hostname, uriFragment) for https://hostname/#uriFragment.

singleChunkSize :: Int64 -> Maybe Word32 Source #