Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.FileTransfer.Description

Synopsis

data FileDescription (p :: FileParty) = FileDescription {
- party :: SFileParty p
- size :: FileSize Int64
- digest :: FileDigest
- key :: SbKey
- nonce :: CbNonce
- chunkSize :: FileSize Word32
- chunks :: [FileChunk]
- redirect :: Maybe RedirectFileInfo
}
data RedirectFileInfo = RedirectFileInfo {
- size :: FileSize Int64
- digest :: FileDigest
}
data AFileDescription = forall p.FilePartyI p => AFD (FileDescription p)
data ValidFileDescription p
pattern ValidFileDescription :: FileDescription p -> ValidFileDescription p
data AValidFileDescription = forall p.FilePartyI p => AVFD (ValidFileDescription p)
newtype FileDigest = FileDigest {
- unFileDigest :: ByteString
}
data FileChunk = FileChunk {
- chunkNo :: Int
- chunkSize :: FileSize Word32
- digest :: FileDigest
- replicas :: [FileChunkReplica]
}
data FileChunkReplica = FileChunkReplica {
- server :: XFTPServer
- replicaId :: ChunkReplicaId
- replicaKey :: APrivateAuthKey
}
data FileServerReplica = FileServerReplica {
- chunkNo :: Int
- server :: XFTPServer
- replicaId :: ChunkReplicaId
- replicaKey :: APrivateAuthKey
- digest :: Maybe FileDigest
- chunkSize :: Maybe (FileSize Word32)
}
newtype FileSize a = FileSize {
- unFileSize :: a
}
newtype ChunkReplicaId = ChunkReplicaId {
- unChunkReplicaId :: XFTPFileId
}
data YAMLFileDescription = YAMLFileDescription {
- party :: FileParty
- size :: String
- digest :: FileDigest
- key :: SbKey
- nonce :: CbNonce
- chunkSize :: String
- replicas :: [YAMLServerReplicas]
- redirect :: Maybe RedirectFileInfo
}
data YAMLServerReplicas = YAMLServerReplicas {
- server :: XFTPServer
- chunks :: [String]
}
validateFileDescription :: FileDescription p -> Either String (ValidFileDescription p)
groupReplicasByServer :: FileSize Word32 -> [FileChunk] -> [NonEmpty FileServerReplica]
fdSeparator :: IsString s => s
kb :: Integral a => a -> a
mb :: Integral a => a -> a
gb :: Integral a => a -> a
data FileDescriptionURI = FileDescriptionURI {
- scheme :: ServiceScheme
- description :: ValidFileDescription 'FRecipient
- clientData :: Maybe FileClientData
}
type FileClientData = Text
fileDescriptionURI :: ValidFileDescription 'FRecipient -> FileDescriptionURI
qrSizeLimit :: Int
maxFileSize :: Int64
maxFileSizeStr :: String
maxFileSizeHard :: Int64
fileSizeLen :: Int64

Documentation

data FileDescription (p :: FileParty) Source #

Constructors

FileDescription
Fields party :: SFileParty p size :: FileSize Int64 digest :: FileDigest key :: SbKey nonce :: CbNonce chunkSize :: FileSize Word32 chunks :: [FileChunk] redirect :: Maybe RedirectFileInfo

Instances

Instances details

Show (FileDescription p) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods showsPrec :: Int -> FileDescription p -> ShowS show :: FileDescription p -> String showList :: [FileDescription p] -> ShowS
Eq (FileDescription p) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods (==) :: FileDescription p -> FileDescription p -> Bool (/=) :: FileDescription p -> FileDescription p -> Bool
FilePartyI p => StrEncoding (FileDescription p) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods strEncode :: FileDescription p -> ByteString Source # strDecode :: ByteString -> Either String (FileDescription p) Source # strP :: Parser (FileDescription p) Source #

data RedirectFileInfo Source #

Constructors

RedirectFileInfo
Fields size :: FileSize Int64 digest :: FileDigest

Instances

Instances details

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

data AFileDescription Source #

Constructors

forall p.FilePartyI p => AFD (FileDescription p)

Instances

Instances details

StrEncoding AFileDescription Source #
Instance details Defined in Simplex.FileTransfer.Description Methods strEncode :: AFileDescription -> ByteString Source # strDecode :: ByteString -> Either String AFileDescription Source # strP :: Parser AFileDescription Source #

data ValidFileDescription p Source #

Instances

Instances details

Show (ValidFileDescription p) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods showsPrec :: Int -> ValidFileDescription p -> ShowS show :: ValidFileDescription p -> String showList :: [ValidFileDescription p] -> ShowS
Eq (ValidFileDescription p) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods (==) :: ValidFileDescription p -> ValidFileDescription p -> Bool (/=) :: ValidFileDescription p -> ValidFileDescription p -> Bool
FilePartyI p => StrEncoding (ValidFileDescription p) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods strEncode :: ValidFileDescription p -> ByteString Source # strDecode :: ByteString -> Either String (ValidFileDescription p) Source # strP :: Parser (ValidFileDescription p) Source #

pattern ValidFileDescription :: FileDescription p -> ValidFileDescription p Source #

data AValidFileDescription Source #

Constructors

forall p.FilePartyI p => AVFD (ValidFileDescription p)

Instances

Instances details

StrEncoding AValidFileDescription Source #
Instance details Defined in Simplex.FileTransfer.Description Methods strEncode :: AValidFileDescription -> ByteString Source # strDecode :: ByteString -> Either String AValidFileDescription Source # strP :: Parser AValidFileDescription Source #

newtype FileDigest Source #

Constructors

FileDigest
Fields unFileDigest :: ByteString

Instances

Instances details

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

data FileChunk Source #

Constructors

FileChunk
Fields chunkNo :: Int chunkSize :: FileSize Word32 digest :: FileDigest replicas :: [FileChunkReplica]

Instances

Instances details

Show FileChunk Source #
Instance details Defined in Simplex.FileTransfer.Description Methods showsPrec :: Int -> FileChunk -> ShowS show :: FileChunk -> String showList :: [FileChunk] -> ShowS
Eq FileChunk Source #
Instance details Defined in Simplex.FileTransfer.Description Methods (==) :: FileChunk -> FileChunk -> Bool (/=) :: FileChunk -> FileChunk -> Bool

data FileChunkReplica Source #

Constructors

FileChunkReplica
Fields server :: XFTPServer replicaId :: ChunkReplicaId replicaKey :: APrivateAuthKey

Instances

Instances details

Show FileChunkReplica Source #
Instance details Defined in Simplex.FileTransfer.Description Methods showsPrec :: Int -> FileChunkReplica -> ShowS show :: FileChunkReplica -> String showList :: [FileChunkReplica] -> ShowS
Eq FileChunkReplica Source #
Instance details Defined in Simplex.FileTransfer.Description Methods (==) :: FileChunkReplica -> FileChunkReplica -> Bool (/=) :: FileChunkReplica -> FileChunkReplica -> Bool

data FileServerReplica Source #

Constructors

FileServerReplica
Fields chunkNo :: Int server :: XFTPServer replicaId :: ChunkReplicaId replicaKey :: APrivateAuthKey digest :: Maybe FileDigest chunkSize :: Maybe (FileSize Word32)

Instances

Instances details

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

newtype FileSize a Source #

Constructors

FileSize
Fields unFileSize :: a

Instances

Instances details

FromJSON a => FromJSON (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods parseJSON :: Value -> Parser (FileSize a) parseJSONList :: Value -> Parser [FileSize a] omittedField :: Maybe (FileSize a)
ToJSON a => ToJSON (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods toJSON :: FileSize a -> Value toEncoding :: FileSize a -> Encoding toJSONList :: [FileSize a] -> Value toEncodingList :: [FileSize a] -> Encoding omitField :: FileSize a -> Bool
(Integral a, Show a) => IsString (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods fromString :: String -> FileSize a
Show a => Show (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods showsPrec :: Int -> FileSize a -> ShowS show :: FileSize a -> String showList :: [FileSize a] -> ShowS
Eq a => Eq (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods (==) :: FileSize a -> FileSize a -> Bool (/=) :: FileSize a -> FileSize a -> Bool
(Integral a, Show a) => StrEncoding (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods strEncode :: FileSize a -> ByteString Source # strDecode :: ByteString -> Either String (FileSize a) Source # strP :: Parser (FileSize a) Source #
FromField a => FromField (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods fromField :: FieldParser (FileSize a) #
ToField a => ToField (FileSize a) Source #
Instance details Defined in Simplex.FileTransfer.Description Methods toField :: FileSize a -> SQLData #

newtype ChunkReplicaId Source #

Constructors

ChunkReplicaId
Fields unChunkReplicaId :: XFTPFileId

Instances

Instances details

FromJSON ChunkReplicaId Source #
Instance details Defined in Simplex.FileTransfer.Description Methods parseJSON :: Value -> Parser ChunkReplicaId parseJSONList :: Value -> Parser [ChunkReplicaId] omittedField :: Maybe ChunkReplicaId
ToJSON ChunkReplicaId Source #
Instance details Defined in Simplex.FileTransfer.Description Methods toJSON :: ChunkReplicaId -> Value toEncoding :: ChunkReplicaId -> Encoding toJSONList :: [ChunkReplicaId] -> Value toEncodingList :: [ChunkReplicaId] -> Encoding omitField :: ChunkReplicaId -> Bool
Show ChunkReplicaId Source #
Instance details Defined in Simplex.FileTransfer.Description Methods showsPrec :: Int -> ChunkReplicaId -> ShowS show :: ChunkReplicaId -> String showList :: [ChunkReplicaId] -> ShowS
Eq ChunkReplicaId Source #
Instance details Defined in Simplex.FileTransfer.Description Methods (==) :: ChunkReplicaId -> ChunkReplicaId -> Bool (/=) :: ChunkReplicaId -> ChunkReplicaId -> Bool
StrEncoding ChunkReplicaId Source #
Instance details Defined in Simplex.FileTransfer.Description Methods strEncode :: ChunkReplicaId -> ByteString Source # strDecode :: ByteString -> Either String ChunkReplicaId Source # strP :: Parser ChunkReplicaId Source #
FromField ChunkReplicaId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods fromField :: FieldParser ChunkReplicaId #
ToField ChunkReplicaId Source #
Instance details Defined in Simplex.Messaging.Agent.Store.AgentStore Methods toField :: ChunkReplicaId -> SQLData #

data YAMLFileDescription Source #

Constructors

YAMLFileDescription
Fields party :: FileParty size :: String digest :: FileDigest key :: SbKey nonce :: CbNonce chunkSize :: String replicas :: [YAMLServerReplicas] redirect :: Maybe RedirectFileInfo

Instances

Instances details

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

data YAMLServerReplicas Source #

Constructors

YAMLServerReplicas
Fields server :: XFTPServer chunks :: [String]

Instances

Instances details

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

validateFileDescription :: FileDescription p -> Either String (ValidFileDescription p) Source #

groupReplicasByServer :: FileSize Word32 -> [FileChunk] -> [NonEmpty FileServerReplica] Source #

fdSeparator :: IsString s => s Source #

kb :: Integral a => a -> a Source #

mb :: Integral a => a -> a Source #

gb :: Integral a => a -> a Source #

data FileDescriptionURI Source #

Constructors

FileDescriptionURI
Fields scheme :: ServiceScheme description :: ValidFileDescription 'FRecipient clientData :: Maybe FileClientData

Instances

Instances details

Show FileDescriptionURI Source #
Instance details Defined in Simplex.FileTransfer.Description Methods showsPrec :: Int -> FileDescriptionURI -> ShowS show :: FileDescriptionURI -> String showList :: [FileDescriptionURI] -> ShowS
Eq FileDescriptionURI Source #
Instance details Defined in Simplex.FileTransfer.Description Methods (==) :: FileDescriptionURI -> FileDescriptionURI -> Bool (/=) :: FileDescriptionURI -> FileDescriptionURI -> Bool
StrEncoding FileDescriptionURI Source #
Instance details Defined in Simplex.FileTransfer.Description Methods strEncode :: FileDescriptionURI -> ByteString Source # strDecode :: ByteString -> Either String FileDescriptionURI Source # strP :: Parser FileDescriptionURI Source #

type FileClientData = Text Source #

fileDescriptionURI :: ValidFileDescription 'FRecipient -> FileDescriptionURI Source #

qrSizeLimit :: Int Source #

URL length in QR code before jumping up to a next size.

maxFileSize :: Int64 Source #

Soft limit for XFTP clients. Should be checked and reported to user.

maxFileSizeStr :: String Source #

maxFileSizeHard :: Int64 Source #

Hard internal limit for XFTP agent after which it refuses to prepare chunks.

fileSizeLen :: Int64 Source #