Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.FileTransfer.Types

Documentation

type RcvFileId = ByteString Source #

type SndFileId = ByteString Source #

data FileHeader Source #

Constructors

FileHeader
Fields fileName :: Text fileExtra :: Maybe Text

Instances

Instances details

Show FileHeader Source #
Instance details Defined in Simplex.FileTransfer.Types Methods showsPrec :: Int -> FileHeader -> ShowS show :: FileHeader -> String showList :: [FileHeader] -> ShowS
Eq FileHeader Source #
Instance details Defined in Simplex.FileTransfer.Types Methods (==) :: FileHeader -> FileHeader -> Bool (/=) :: FileHeader -> FileHeader -> Bool
Encoding FileHeader Source #
Instance details Defined in Simplex.FileTransfer.Types Methods smpEncode :: FileHeader -> ByteString Source # smpDecode :: ByteString -> Either String FileHeader Source # smpP :: Parser FileHeader Source #

type DBRcvFileId = Int64 Source #

data RcvFile Source #

Constructors

RcvFile
Fields rcvFileId :: DBRcvFileId rcvFileEntityId :: RcvFileId userId :: Int64 size :: FileSize Int64 digest :: FileDigest key :: SbKey nonce :: CbNonce chunkSize :: FileSize Word32 redirect :: Maybe RcvFileRedirect chunks :: [RcvFileChunk] prefixPath :: FilePath tmpPath :: Maybe FilePath saveFile :: CryptoFile status :: RcvFileStatus deleted :: Bool

Instances

Instances details

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

data RcvFileStatus Source #

Constructors

RFSReceiving
RFSReceived
RFSDecrypting
RFSComplete
RFSError

Instances

Instances details

Show RcvFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods showsPrec :: Int -> RcvFileStatus -> ShowS show :: RcvFileStatus -> String showList :: [RcvFileStatus] -> ShowS
Eq RcvFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods (==) :: RcvFileStatus -> RcvFileStatus -> Bool (/=) :: RcvFileStatus -> RcvFileStatus -> Bool
TextEncoding RcvFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods textEncode :: RcvFileStatus -> Text Source # textDecode :: Text -> Maybe RcvFileStatus Source #
FromField RcvFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods fromField :: FieldParser RcvFileStatus #
ToField RcvFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods toField :: RcvFileStatus -> SQLData #

data RcvFileChunk Source #

Constructors

RcvFileChunk
Fields rcvFileId :: DBRcvFileId rcvFileEntityId :: RcvFileId userId :: Int64 rcvChunkId :: Int64 chunkNo :: Int chunkSize :: FileSize Word32 digest :: FileDigest replicas :: [RcvFileChunkReplica] fileTmpPath :: FilePath chunkTmpPath :: Maybe FilePath

Instances

Instances details

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

data RcvFileChunkReplica Source #

Constructors

RcvFileChunkReplica
Fields rcvChunkReplicaId :: Int64 server :: XFTPServer replicaId :: ChunkReplicaId replicaKey :: APrivateAuthKey received :: Bool delay :: Maybe Int64 retries :: Int

Instances

Instances details

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

data RcvFileRedirect Source #

Constructors

RcvFileRedirect
Fields redirectDbId :: DBRcvFileId redirectEntityId :: RcvFileId redirectFileInfo :: RedirectFileInfo

Instances

Instances details

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

type DBSndFileId = Int64 Source #

data SndFile Source #

Constructors

SndFile
Fields sndFileId :: DBSndFileId sndFileEntityId :: SndFileId userId :: Int64 numRecipients :: Int digest :: Maybe FileDigest key :: SbKey nonce :: CbNonce chunks :: [SndFileChunk] srcFile :: CryptoFile prefixPath :: Maybe FilePath status :: SndFileStatus deleted :: Bool redirect :: Maybe RedirectFileInfo

Instances

Instances details

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

data SndFileStatus Source #

Constructors

SFSNew
SFSEncrypting
SFSEncrypted
SFSUploading
SFSComplete
SFSError

Instances

Instances details

Show SndFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods showsPrec :: Int -> SndFileStatus -> ShowS show :: SndFileStatus -> String showList :: [SndFileStatus] -> ShowS
Eq SndFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods (==) :: SndFileStatus -> SndFileStatus -> Bool (/=) :: SndFileStatus -> SndFileStatus -> Bool
TextEncoding SndFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods textEncode :: SndFileStatus -> Text Source # textDecode :: Text -> Maybe SndFileStatus Source #
FromField SndFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods fromField :: FieldParser SndFileStatus #
ToField SndFileStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods toField :: SndFileStatus -> SQLData #

data SndFileChunk Source #

Constructors

SndFileChunk
Fields sndFileId :: DBSndFileId sndFileEntityId :: SndFileId userId :: Int64 numRecipients :: Int sndChunkId :: Int64 chunkNo :: Int chunkSpec :: XFTPChunkSpec filePrefixPath :: FilePath digest :: FileDigest replicas :: [SndFileChunkReplica]

Instances

Instances details

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

data NewSndChunkReplica Source #

Constructors

NewSndChunkReplica
Fields server :: XFTPServer replicaId :: ChunkReplicaId replicaKey :: APrivateAuthKey rcvIdsKeys :: [(ChunkReplicaId, APrivateAuthKey)]

Instances

Instances details

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

data SndFileChunkReplica Source #

Constructors

SndFileChunkReplica
Fields sndChunkReplicaId :: Int64 server :: XFTPServer replicaId :: ChunkReplicaId replicaKey :: APrivateAuthKey rcvIdsKeys :: [(ChunkReplicaId, APrivateAuthKey)] replicaStatus :: SndFileReplicaStatus delay :: Maybe Int64 retries :: Int

Instances

Instances details

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

data SndFileReplicaStatus Source #

Constructors

SFRSCreated
SFRSUploaded

Instances

Instances details

Show SndFileReplicaStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods showsPrec :: Int -> SndFileReplicaStatus -> ShowS show :: SndFileReplicaStatus -> String showList :: [SndFileReplicaStatus] -> ShowS
Eq SndFileReplicaStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods (==) :: SndFileReplicaStatus -> SndFileReplicaStatus -> Bool (/=) :: SndFileReplicaStatus -> SndFileReplicaStatus -> Bool
TextEncoding SndFileReplicaStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods textEncode :: SndFileReplicaStatus -> Text Source # textDecode :: Text -> Maybe SndFileReplicaStatus Source #
FromField SndFileReplicaStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods fromField :: FieldParser SndFileReplicaStatus #
ToField SndFileReplicaStatus Source #
Instance details Defined in Simplex.FileTransfer.Types Methods toField :: SndFileReplicaStatus -> SQLData #

data DeletedSndChunkReplica Source #

Constructors

DeletedSndChunkReplica
Fields deletedSndChunkReplicaId :: Int64 userId :: Int64 server :: XFTPServer replicaId :: ChunkReplicaId replicaKey :: APrivateAuthKey chunkDigest :: FileDigest delay :: Maybe Int64 retries :: Int

Instances

Instances details

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

data SentRecipientReplica Source #

Constructors

SentRecipientReplica
Fields chunkNo :: Int server :: XFTPServer rcvNo :: Int replicaId :: ChunkReplicaId replicaKey :: APrivateAuthKey digest :: FileDigest chunkSize :: FileSize Word32

data FileErrorType Source #

Constructors

NOT_APPROVED	cannot proceed with download from not approved relays without proxy
SIZE	max file size exceeded
REDIRECT	bad redirect data
Fields redirectError :: String
FILE_IO	file crypto error
Fields fileIOError :: String
NO_FILE	file not found or was deleted

Instances

Instances details

FromJSON FileErrorType Source #
Instance details Defined in Simplex.FileTransfer.Types Methods parseJSON :: Value -> Parser FileErrorType parseJSONList :: Value -> Parser [FileErrorType] omittedField :: Maybe FileErrorType
ToJSON FileErrorType Source #
Instance details Defined in Simplex.FileTransfer.Types Methods toJSON :: FileErrorType -> Value toEncoding :: FileErrorType -> Encoding toJSONList :: [FileErrorType] -> Value toEncodingList :: [FileErrorType] -> Encoding omitField :: FileErrorType -> Bool
Show FileErrorType Source #
Instance details Defined in Simplex.FileTransfer.Types Methods showsPrec :: Int -> FileErrorType -> ShowS show :: FileErrorType -> String showList :: [FileErrorType] -> ShowS
Eq FileErrorType Source #
Instance details Defined in Simplex.FileTransfer.Types Methods (==) :: FileErrorType -> FileErrorType -> Bool (/=) :: FileErrorType -> FileErrorType -> Bool
StrEncoding FileErrorType Source #
Instance details Defined in Simplex.FileTransfer.Types Methods strEncode :: FileErrorType -> ByteString Source # strDecode :: ByteString -> Either String FileErrorType Source # strP :: Parser FileErrorType Source #

authTagSize :: Int64 Source #

sndFileEncPath :: FilePath -> FilePath Source #

sndChunkSize :: SndFileChunk -> Word32 Source #