TahoeLAFS.Storage.API

Documentation

data Version

Constructors

Version

Fields

• parameters :: Version1Parameters
• applicationVersion :: ApplicationVersion

Instances

Eq Version

Defined in TahoeLAFS.Storage.API

Methods

(==) :: Version -> Version -> Bool

(/=) :: Version -> Version -> Bool

Show Version

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Generic Version

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep Version :: Type -> Type

Methods

from :: Version -> Rep Version x

to :: Rep Version x -> Version

ToJSON Version

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: Version -> Value

toEncoding :: Version -> Encoding

toJSONList :: [Version] -> Value

toEncodingList :: [Version] -> Encoding

FromJSON Version

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser Version

parseJSONList :: Value -> Parser [Version]

Serialise Version

Defined in TahoeLAFS.Storage.API

Methods

encode :: Version -> Encoding

decode :: Decoder s Version

encodeList :: [Version] -> Encoding

decodeList :: Decoder s [Version]

ToSample Version

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy Version -> [(Text, Version)]

type Rep Version

Defined in TahoeLAFS.Storage.API

type Rep Version = D1 ('MetaData "Version" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "Version" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Version1Parameters) :*: S1 ('MetaSel ('Just "applicationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApplicationVersion)))

type Size = Integer

type Offset = Integer

type StorageIndex = String

newtype ShareNumber

Constructors

ShareNumber Integer

Instances

Eq ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

(==) :: ShareNumber -> ShareNumber -> Bool

(/=) :: ShareNumber -> ShareNumber -> Bool

Ord ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

compare :: ShareNumber -> ShareNumber -> Ordering

(<) :: ShareNumber -> ShareNumber -> Bool

(<=) :: ShareNumber -> ShareNumber -> Bool

(>) :: ShareNumber -> ShareNumber -> Bool

(>=) :: ShareNumber -> ShareNumber -> Bool

max :: ShareNumber -> ShareNumber -> ShareNumber

min :: ShareNumber -> ShareNumber -> ShareNumber

Show ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> ShareNumber -> ShowS

show :: ShareNumber -> String

showList :: [ShareNumber] -> ShowS

Generic ShareNumber

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep ShareNumber :: Type -> Type

Methods

from :: ShareNumber -> Rep ShareNumber x

to :: Rep ShareNumber x -> ShareNumber

ToJSON ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: ShareNumber -> Value

toEncoding :: ShareNumber -> Encoding

toJSONList :: [ShareNumber] -> Value

toEncodingList :: [ShareNumber] -> Encoding

ToJSONKey ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

toJSONKey :: ToJSONKeyFunction ShareNumber

toJSONKeyList :: ToJSONKeyFunction [ShareNumber]

FromJSON ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser ShareNumber

parseJSONList :: Value -> Parser [ShareNumber]

FromJSONKey ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

fromJSONKey :: FromJSONKeyFunction ShareNumber

fromJSONKeyList :: FromJSONKeyFunction [ShareNumber]

ToHttpApiData ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

toUrlPiece :: ShareNumber -> Text

toEncodedUrlPiece :: ShareNumber -> Builder

toHeader :: ShareNumber -> ByteString

toQueryParam :: ShareNumber -> Text

FromHttpApiData ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

parseUrlPiece :: Text -> Either Text ShareNumber

parseHeader :: ByteString -> Either Text ShareNumber

parseQueryParam :: Text -> Either Text ShareNumber

Serialise ShareNumber

Defined in TahoeLAFS.Storage.API

Methods

encode :: ShareNumber -> Encoding

decode :: Decoder s ShareNumber

encodeList :: [ShareNumber] -> Encoding

decodeList :: Decoder s [ShareNumber]

ToSample ReadResult

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy ReadResult -> [(Text, ReadResult)]

ToSample ShareNumber

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy ShareNumber -> [(Text, ShareNumber)]

ToParam (QueryParams "share_number" ShareNumber)

Defined in TahoeLAFS.Storage.APIDocs

Methods

toParam :: Proxy (QueryParams "share_number" ShareNumber) -> DocQueryParam

ToCapture (Capture "share_number" ShareNumber)

Defined in TahoeLAFS.Storage.APIDocs

Methods

toCapture :: Proxy (Capture "share_number" ShareNumber) -> DocCapture

type Rep ShareNumber

Defined in TahoeLAFS.Storage.API

type Rep ShareNumber = D1 ('MetaData "ShareNumber" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'True) (C1 ('MetaCons "ShareNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

shareNumber :: Integer -> Maybe ShareNumber

toInteger :: ShareNumber -> Integer

type ShareData = ByteString

type ApplicationVersion = ByteString

data Version1Parameters

Constructors

Version1Parameters

Fields

• maximumImmutableShareSize :: Size
• maximumMutableShareSize :: Size
• availableSpace :: Size

Instances

Eq Version1Parameters

Defined in TahoeLAFS.Storage.API

Methods

(==) :: Version1Parameters -> Version1Parameters -> Bool

(/=) :: Version1Parameters -> Version1Parameters -> Bool

Show Version1Parameters

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> Version1Parameters -> ShowS

show :: Version1Parameters -> String

showList :: [Version1Parameters] -> ShowS

Generic Version1Parameters

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep Version1Parameters :: Type -> Type

Methods

from :: Version1Parameters -> Rep Version1Parameters x

to :: Rep Version1Parameters x -> Version1Parameters

ToJSON Version1Parameters

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: Version1Parameters -> Value

toEncoding :: Version1Parameters -> Encoding

toJSONList :: [Version1Parameters] -> Value

toEncodingList :: [Version1Parameters] -> Encoding

FromJSON Version1Parameters

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser Version1Parameters

parseJSONList :: Value -> Parser [Version1Parameters]

Serialise Version1Parameters

Defined in TahoeLAFS.Storage.API

Methods

encode :: Version1Parameters -> Encoding

decode :: Decoder s Version1Parameters

encodeList :: [Version1Parameters] -> Encoding

decodeList :: Decoder s [Version1Parameters]

type Rep Version1Parameters

Defined in TahoeLAFS.Storage.API

type Rep Version1Parameters = D1 ('MetaData "Version1Parameters" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "Version1Parameters" 'PrefixI 'True) (S1 ('MetaSel ('Just "maximumImmutableShareSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Size) :*: (S1 ('MetaSel ('Just "maximumMutableShareSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Size) :*: S1 ('MetaSel ('Just "availableSpace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Size))))

data AllocateBuckets

Constructors

AllocateBuckets

Fields

• shareNumbers :: [ShareNumber]
• allocatedSize :: Size

Instances

Eq AllocateBuckets

Defined in TahoeLAFS.Storage.API

Methods

(==) :: AllocateBuckets -> AllocateBuckets -> Bool

(/=) :: AllocateBuckets -> AllocateBuckets -> Bool

Show AllocateBuckets

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> AllocateBuckets -> ShowS

show :: AllocateBuckets -> String

showList :: [AllocateBuckets] -> ShowS

Generic AllocateBuckets

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep AllocateBuckets :: Type -> Type

Methods

from :: AllocateBuckets -> Rep AllocateBuckets x

to :: Rep AllocateBuckets x -> AllocateBuckets

ToJSON AllocateBuckets

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: AllocateBuckets -> Value

toEncoding :: AllocateBuckets -> Encoding

toJSONList :: [AllocateBuckets] -> Value

toEncodingList :: [AllocateBuckets] -> Encoding

FromJSON AllocateBuckets

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser AllocateBuckets

parseJSONList :: Value -> Parser [AllocateBuckets]

Serialise AllocateBuckets

Defined in TahoeLAFS.Storage.API

Methods

encode :: AllocateBuckets -> Encoding

decode :: Decoder s AllocateBuckets

encodeList :: [AllocateBuckets] -> Encoding

decodeList :: Decoder s [AllocateBuckets]

ToSample AllocateBuckets

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy AllocateBuckets -> [(Text, AllocateBuckets)]

type Rep AllocateBuckets

Defined in TahoeLAFS.Storage.API

type Rep AllocateBuckets = D1 ('MetaData "AllocateBuckets" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "AllocateBuckets" 'PrefixI 'True) (S1 ('MetaSel ('Just "shareNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ShareNumber]) :*: S1 ('MetaSel ('Just "allocatedSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Size)))

data AllocationResult

Constructors

AllocationResult

Fields

• alreadyHave :: [ShareNumber]
• allocated :: [ShareNumber]

Instances

Eq AllocationResult

Defined in TahoeLAFS.Storage.API

Methods

(==) :: AllocationResult -> AllocationResult -> Bool

(/=) :: AllocationResult -> AllocationResult -> Bool

Show AllocationResult

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> AllocationResult -> ShowS

show :: AllocationResult -> String

showList :: [AllocationResult] -> ShowS

Generic AllocationResult

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep AllocationResult :: Type -> Type

Methods

from :: AllocationResult -> Rep AllocationResult x

to :: Rep AllocationResult x -> AllocationResult

ToJSON AllocationResult

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: AllocationResult -> Value

toEncoding :: AllocationResult -> Encoding

toJSONList :: [AllocationResult] -> Value

toEncodingList :: [AllocationResult] -> Encoding

FromJSON AllocationResult

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser AllocationResult

parseJSONList :: Value -> Parser [AllocationResult]

Serialise AllocationResult

Defined in TahoeLAFS.Storage.API

Methods

encode :: AllocationResult -> Encoding

decode :: Decoder s AllocationResult

encodeList :: [AllocationResult] -> Encoding

decodeList :: Decoder s [AllocationResult]

ToSample AllocationResult

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy AllocationResult -> [(Text, AllocationResult)]

type Rep AllocationResult

Defined in TahoeLAFS.Storage.API

type Rep AllocationResult = D1 ('MetaData "AllocationResult" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "AllocationResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "alreadyHave") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ShareNumber]) :*: S1 ('MetaSel ('Just "allocated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ShareNumber])))

data TestWriteVectors

Constructors

TestWriteVectors

Fields

• test :: [TestVector]
• write :: [WriteVector]
• newLength :: Maybe Integer

Instances

Eq TestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

(==) :: TestWriteVectors -> TestWriteVectors -> Bool

(/=) :: TestWriteVectors -> TestWriteVectors -> Bool

Show TestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> TestWriteVectors -> ShowS

show :: TestWriteVectors -> String

showList :: [TestWriteVectors] -> ShowS

Generic TestWriteVectors

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep TestWriteVectors :: Type -> Type

Methods

from :: TestWriteVectors -> Rep TestWriteVectors x

to :: Rep TestWriteVectors x -> TestWriteVectors

Semigroup TestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

(<>) :: TestWriteVectors -> TestWriteVectors -> TestWriteVectors

sconcat :: NonEmpty TestWriteVectors -> TestWriteVectors

stimes :: Integral b => b -> TestWriteVectors -> TestWriteVectors

Monoid TestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

mempty :: TestWriteVectors

mappend :: TestWriteVectors -> TestWriteVectors -> TestWriteVectors

mconcat :: [TestWriteVectors] -> TestWriteVectors

ToJSON TestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: TestWriteVectors -> Value

toEncoding :: TestWriteVectors -> Encoding

toJSONList :: [TestWriteVectors] -> Value

toEncodingList :: [TestWriteVectors] -> Encoding

FromJSON TestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser TestWriteVectors

parseJSONList :: Value -> Parser [TestWriteVectors]

Serialise TestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

encode :: TestWriteVectors -> Encoding

decode :: Decoder s TestWriteVectors

encodeList :: [TestWriteVectors] -> Encoding

decodeList :: Decoder s [TestWriteVectors]

type Rep TestWriteVectors

Defined in TahoeLAFS.Storage.API

type Rep TestWriteVectors = D1 ('MetaData "TestWriteVectors" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "TestWriteVectors" 'PrefixI 'True) (S1 ('MetaSel ('Just "test") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TestVector]) :*: (S1 ('MetaSel ('Just "write") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WriteVector]) :*: S1 ('MetaSel ('Just "newLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))

data WriteVector

Constructors

WriteVector

Fields

• writeOffset :: Offset
• shareData :: ShareData

Instances

Eq WriteVector

Defined in TahoeLAFS.Storage.API

Methods

(==) :: WriteVector -> WriteVector -> Bool

(/=) :: WriteVector -> WriteVector -> Bool

Show WriteVector

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> WriteVector -> ShowS

show :: WriteVector -> String

showList :: [WriteVector] -> ShowS

Generic WriteVector

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep WriteVector :: Type -> Type

Methods

from :: WriteVector -> Rep WriteVector x

to :: Rep WriteVector x -> WriteVector

ToJSON WriteVector

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: WriteVector -> Value

toEncoding :: WriteVector -> Encoding

toJSONList :: [WriteVector] -> Value

toEncodingList :: [WriteVector] -> Encoding

FromJSON WriteVector

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser WriteVector

parseJSONList :: Value -> Parser [WriteVector]

Serialise WriteVector

Defined in TahoeLAFS.Storage.API

Methods

encode :: WriteVector -> Encoding

decode :: Decoder s WriteVector

encodeList :: [WriteVector] -> Encoding

decodeList :: Decoder s [WriteVector]

type Rep WriteVector

Defined in TahoeLAFS.Storage.API

type Rep WriteVector = D1 ('MetaData "WriteVector" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "WriteVector" 'PrefixI 'True) (S1 ('MetaSel ('Just "writeOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset) :*: S1 ('MetaSel ('Just "shareData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShareData)))

data ReadTestWriteVectors

Constructors

ReadTestWriteVectors

Fields

• testWriteVectors :: Map ShareNumber TestWriteVectors
• readVector :: [ReadVector]

Instances

Eq ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

(==) :: ReadTestWriteVectors -> ReadTestWriteVectors -> Bool

(/=) :: ReadTestWriteVectors -> ReadTestWriteVectors -> Bool

Show ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> ReadTestWriteVectors -> ShowS

show :: ReadTestWriteVectors -> String

showList :: [ReadTestWriteVectors] -> ShowS

Generic ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep ReadTestWriteVectors :: Type -> Type

Methods

from :: ReadTestWriteVectors -> Rep ReadTestWriteVectors x

to :: Rep ReadTestWriteVectors x -> ReadTestWriteVectors

Semigroup ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

(<>) :: ReadTestWriteVectors -> ReadTestWriteVectors -> ReadTestWriteVectors

sconcat :: NonEmpty ReadTestWriteVectors -> ReadTestWriteVectors

stimes :: Integral b => b -> ReadTestWriteVectors -> ReadTestWriteVectors

Monoid ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

mempty :: ReadTestWriteVectors

mappend :: ReadTestWriteVectors -> ReadTestWriteVectors -> ReadTestWriteVectors

mconcat :: [ReadTestWriteVectors] -> ReadTestWriteVectors

ToJSON ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: ReadTestWriteVectors -> Value

toEncoding :: ReadTestWriteVectors -> Encoding

toJSONList :: [ReadTestWriteVectors] -> Value

toEncodingList :: [ReadTestWriteVectors] -> Encoding

FromJSON ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser ReadTestWriteVectors

parseJSONList :: Value -> Parser [ReadTestWriteVectors]

Serialise ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

Methods

encode :: ReadTestWriteVectors -> Encoding

decode :: Decoder s ReadTestWriteVectors

encodeList :: [ReadTestWriteVectors] -> Encoding

decodeList :: Decoder s [ReadTestWriteVectors]

ToSample ReadTestWriteVectors

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy ReadTestWriteVectors -> [(Text, ReadTestWriteVectors)]

type Rep ReadTestWriteVectors

Defined in TahoeLAFS.Storage.API

type Rep ReadTestWriteVectors = D1 ('MetaData "ReadTestWriteVectors" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "ReadTestWriteVectors" 'PrefixI 'True) (S1 ('MetaSel ('Just "testWriteVectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map ShareNumber TestWriteVectors)) :*: S1 ('MetaSel ('Just "readVector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ReadVector])))

data ReadTestWriteResult

Constructors

ReadTestWriteResult

Fields

• success :: Bool
• readData :: ReadResult

Instances

Eq ReadTestWriteResult

Defined in TahoeLAFS.Storage.API

Methods

(==) :: ReadTestWriteResult -> ReadTestWriteResult -> Bool

(/=) :: ReadTestWriteResult -> ReadTestWriteResult -> Bool

Show ReadTestWriteResult

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> ReadTestWriteResult -> ShowS

show :: ReadTestWriteResult -> String

showList :: [ReadTestWriteResult] -> ShowS

Generic ReadTestWriteResult

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep ReadTestWriteResult :: Type -> Type

Methods

from :: ReadTestWriteResult -> Rep ReadTestWriteResult x

to :: Rep ReadTestWriteResult x -> ReadTestWriteResult

ToJSON ReadTestWriteResult

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: ReadTestWriteResult -> Value

toEncoding :: ReadTestWriteResult -> Encoding

toJSONList :: [ReadTestWriteResult] -> Value

toEncodingList :: [ReadTestWriteResult] -> Encoding

FromJSON ReadTestWriteResult

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser ReadTestWriteResult

parseJSONList :: Value -> Parser [ReadTestWriteResult]

Serialise ReadTestWriteResult

Defined in TahoeLAFS.Storage.API

Methods

encode :: ReadTestWriteResult -> Encoding

decode :: Decoder s ReadTestWriteResult

encodeList :: [ReadTestWriteResult] -> Encoding

decodeList :: Decoder s [ReadTestWriteResult]

ToSample ReadTestWriteResult

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy ReadTestWriteResult -> [(Text, ReadTestWriteResult)]

type Rep ReadTestWriteResult

Defined in TahoeLAFS.Storage.API

type Rep ReadTestWriteResult = D1 ('MetaData "ReadTestWriteResult" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "ReadTestWriteResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "success") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "readData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReadResult)))

data ReadVector

Constructors

ReadVector

Fields

• offset :: Offset
• readSize :: Size

Instances

Eq ReadVector

Defined in TahoeLAFS.Storage.API

Methods

(==) :: ReadVector -> ReadVector -> Bool

(/=) :: ReadVector -> ReadVector -> Bool

Show ReadVector

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> ReadVector -> ShowS

show :: ReadVector -> String

showList :: [ReadVector] -> ShowS

Generic ReadVector

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep ReadVector :: Type -> Type

Methods

from :: ReadVector -> Rep ReadVector x

to :: Rep ReadVector x -> ReadVector

ToJSON ReadVector

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: ReadVector -> Value

toEncoding :: ReadVector -> Encoding

toJSONList :: [ReadVector] -> Value

toEncodingList :: [ReadVector] -> Encoding

FromJSON ReadVector

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser ReadVector

parseJSONList :: Value -> Parser [ReadVector]

Serialise ReadVector

Defined in TahoeLAFS.Storage.API

Methods

encode :: ReadVector -> Encoding

decode :: Decoder s ReadVector

encodeList :: [ReadVector] -> Encoding

decodeList :: Decoder s [ReadVector]

type Rep ReadVector

Defined in TahoeLAFS.Storage.API

type Rep ReadVector = D1 ('MetaData "ReadVector" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "ReadVector" 'PrefixI 'True) (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset) :*: S1 ('MetaSel ('Just "readSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Size)))

type QueryRange = Maybe ByteRanges

data TestVector

Constructors

TestVector

Fields

• testOffset :: Offset
• testSize :: Size
• operator :: TestOperator
• specimen :: ShareData

Instances

Eq TestVector

Defined in TahoeLAFS.Storage.API

Methods

(==) :: TestVector -> TestVector -> Bool

(/=) :: TestVector -> TestVector -> Bool

Show TestVector

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> TestVector -> ShowS

show :: TestVector -> String

showList :: [TestVector] -> ShowS

Generic TestVector

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep TestVector :: Type -> Type

Methods

from :: TestVector -> Rep TestVector x

to :: Rep TestVector x -> TestVector

ToJSON TestVector

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: TestVector -> Value

toEncoding :: TestVector -> Encoding

toJSONList :: [TestVector] -> Value

toEncodingList :: [TestVector] -> Encoding

FromJSON TestVector

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser TestVector

parseJSONList :: Value -> Parser [TestVector]

Serialise TestVector

Defined in TahoeLAFS.Storage.API

Methods

encode :: TestVector -> Encoding

decode :: Decoder s TestVector

encodeList :: [TestVector] -> Encoding

decodeList :: Decoder s [TestVector]

type Rep TestVector

Defined in TahoeLAFS.Storage.API

type Rep TestVector = D1 ('MetaData "TestVector" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) (C1 ('MetaCons "TestVector" 'PrefixI 'True) ((S1 ('MetaSel ('Just "testOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset) :*: S1 ('MetaSel ('Just "testSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Size)) :*: (S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TestOperator) :*: S1 ('MetaSel ('Just "specimen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ShareData))))

type ReadResult = Map ShareNumber [ShareData]

newtype CorruptionDetails

Constructors

CorruptionDetails

Fields

• reason :: String

Instances

Eq CorruptionDetails

Defined in TahoeLAFS.Storage.API

Methods

(==) :: CorruptionDetails -> CorruptionDetails -> Bool

(/=) :: CorruptionDetails -> CorruptionDetails -> Bool

Show CorruptionDetails

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> CorruptionDetails -> ShowS

show :: CorruptionDetails -> String

showList :: [CorruptionDetails] -> ShowS

Generic CorruptionDetails

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep CorruptionDetails :: Type -> Type

Methods

from :: CorruptionDetails -> Rep CorruptionDetails x

to :: Rep CorruptionDetails x -> CorruptionDetails

ToJSON CorruptionDetails

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: CorruptionDetails -> Value

toEncoding :: CorruptionDetails -> Encoding

toJSONList :: [CorruptionDetails] -> Value

toEncodingList :: [CorruptionDetails] -> Encoding

FromJSON CorruptionDetails

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser CorruptionDetails

parseJSONList :: Value -> Parser [CorruptionDetails]

Serialise CorruptionDetails

Defined in TahoeLAFS.Storage.API

Methods

encode :: CorruptionDetails -> Encoding

decode :: Decoder s CorruptionDetails

encodeList :: [CorruptionDetails] -> Encoding

decodeList :: Decoder s [CorruptionDetails]

ToSample CorruptionDetails

Defined in TahoeLAFS.Storage.APIDocs

Methods

toSamples :: Proxy CorruptionDetails -> [(Text, CorruptionDetails)]

type Rep CorruptionDetails

Defined in TahoeLAFS.Storage.API

type Rep CorruptionDetails = D1 ('MetaData "CorruptionDetails" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'True) (C1 ('MetaCons "CorruptionDetails" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

data TestOperator

Constructors

Lt

Le

Eq

Ne

Ge

Gt

Instances

Eq TestOperator

Defined in TahoeLAFS.Storage.API

Methods

(==) :: TestOperator -> TestOperator -> Bool

(/=) :: TestOperator -> TestOperator -> Bool

Show TestOperator

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> TestOperator -> ShowS

show :: TestOperator -> String

showList :: [TestOperator] -> ShowS

Generic TestOperator

Defined in TahoeLAFS.Storage.API

Associated Types

type Rep TestOperator :: Type -> Type

Methods

from :: TestOperator -> Rep TestOperator x

to :: Rep TestOperator x -> TestOperator

ToJSON TestOperator

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: TestOperator -> Value

toEncoding :: TestOperator -> Encoding

toJSONList :: [TestOperator] -> Value

toEncodingList :: [TestOperator] -> Encoding

FromJSON TestOperator

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser TestOperator

parseJSONList :: Value -> Parser [TestOperator]

Serialise TestOperator

Defined in TahoeLAFS.Storage.API

Methods

encode :: TestOperator -> Encoding

decode :: Decoder s TestOperator

encodeList :: [TestOperator] -> Encoding

decodeList :: Decoder s [TestOperator]

type Rep TestOperator

Defined in TahoeLAFS.Storage.API

type Rep TestOperator = D1 ('MetaData "TestOperator" "TahoeLAFS.Storage.API" "tahoe-great-black-swamp-0.4.0.1-inplace" 'False) ((C1 ('MetaCons "Lt" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Le" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Eq" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Ne" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Ge" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Gt" 'PrefixI 'False) (U1 :: Type -> Type))))

type StorageAPI = "storage" :> ("v1" :> (GetVersion :<|> (RenewLease :<|> (CreateImmutableStorageIndex :<|> (WriteImmutableShareData :<|> (AbortImmutableUpload :<|> (ReadImmutableShareData :<|> (("immutable" :> GetShareNumbers) :<|> (("immutable" :> AdviseCorrupt) :<|> (ReadTestWrite :<|> (ReadMutableShareData :<|> (("mutable" :> GetShareNumbers) :<|> ("mutable" :> AdviseCorrupt)))))))))))))

data LeaseSecret

Constructors

Renew ByteString

Cancel ByteString

Upload UploadSecret

Write WriteEnablerSecret

Instances

ToHttpApiData LeaseSecret

Defined in TahoeLAFS.Storage.API

Methods

toUrlPiece :: LeaseSecret -> Text

toEncodedUrlPiece :: LeaseSecret -> Builder

toHeader :: LeaseSecret -> ByteString

toQueryParam :: LeaseSecret -> Text

FromHttpApiData LeaseSecret

Defined in TahoeLAFS.Storage.API

Methods

parseUrlPiece :: Text -> Either Text LeaseSecret

parseHeader :: ByteString -> Either Text LeaseSecret

parseQueryParam :: Text -> Either Text LeaseSecret

ToHttpApiData [LeaseSecret]

Defined in TahoeLAFS.Storage.API

Methods

toUrlPiece :: [LeaseSecret] -> Text

toEncodedUrlPiece :: [LeaseSecret] -> Builder

toHeader :: [LeaseSecret] -> ByteString

toQueryParam :: [LeaseSecret] -> Text

FromHttpApiData [LeaseSecret]

Defined in TahoeLAFS.Storage.API

Methods

parseUrlPiece :: Text -> Either Text [LeaseSecret]

parseHeader :: ByteString -> Either Text [LeaseSecret]

parseQueryParam :: Text -> Either Text [LeaseSecret]

newtype UploadSecret

Constructors

UploadSecret ByteString

newtype WriteEnablerSecret

Constructors

WriteEnablerSecret ByteString

Instances

Eq WriteEnablerSecret

Defined in TahoeLAFS.Storage.API

Methods

(==) :: WriteEnablerSecret -> WriteEnablerSecret -> Bool

(/=) :: WriteEnablerSecret -> WriteEnablerSecret -> Bool

isUploadSecret :: LeaseSecret -> Bool

api :: Proxy StorageAPI

renewSecretLength :: Num a => a

writeEnablerSecretLength :: Num a => a

leaseRenewSecretLength :: Num a => a

leaseCancelSecretLength :: Num a => a

data CBOR

Instances

Accept CBOR

Defined in TahoeLAFS.Internal.ServantUtil

Methods

contentType :: Proxy CBOR -> MediaType

contentTypes :: Proxy CBOR -> NonEmpty MediaType

Serialise a => MimeRender CBOR a

Defined in TahoeLAFS.Internal.ServantUtil

Methods

mimeRender :: Proxy CBOR -> a -> ByteString

Serialise a => MimeUnrender CBOR a

Defined in TahoeLAFS.Internal.ServantUtil

Methods

mimeUnrender :: Proxy CBOR -> ByteString -> Either String a

mimeUnrenderWithType :: Proxy CBOR -> MediaType -> ByteString -> Either String a

newtype CBORSet a

A new type for which we can define our own CBOR serialisation rules. The cborg library provides a Serialise instance for Set which is not compatible with the representation required by Tahoe-LAFS.

Constructors

CBORSet

Fields

• getCBORSet :: Set a

Instances

Eq a => Eq (CBORSet a)

Defined in TahoeLAFS.Storage.API

Methods

(==) :: CBORSet a -> CBORSet a -> Bool

(/=) :: CBORSet a -> CBORSet a -> Bool

Show a => Show (CBORSet a)

Defined in TahoeLAFS.Storage.API

Methods

showsPrec :: Int -> CBORSet a -> ShowS

show :: CBORSet a -> String

showList :: [CBORSet a] -> ShowS

ToJSON a => ToJSON (CBORSet a)

Defined in TahoeLAFS.Storage.API

Methods

toJSON :: CBORSet a -> Value

toEncoding :: CBORSet a -> Encoding

toJSONList :: [CBORSet a] -> Value

toEncodingList :: [CBORSet a] -> Encoding

(Ord a, FromJSON a) => FromJSON (CBORSet a)

Defined in TahoeLAFS.Storage.API

Methods

parseJSON :: Value -> Parser (CBORSet a)

parseJSONList :: Value -> Parser [CBORSet a]

(Serialise a, Ord a) => Serialise (CBORSet a)

Define serialisation for CBORSets in a way that is compatible with GBS.

Defined in TahoeLAFS.Storage.API

Methods

encode :: CBORSet a -> Encoding

decode :: Decoder s (CBORSet a)

encodeList :: [CBORSet a] -> Encoding

decodeList :: Decoder s [CBORSet a]

readv :: Offset -> Size -> ReadTestWriteVectors

writev :: ShareNumber -> Offset -> ShareData -> ReadTestWriteVectors

testv :: ShareNumber -> Offset -> ShareData -> ReadTestWriteVectors

Orphan instances

ToHttpApiData ByteRanges

Methods

toUrlPiece :: ByteRanges -> Text

toEncodedUrlPiece :: ByteRanges -> Builder

toHeader :: ByteRanges -> ByteString

toQueryParam :: ByteRanges -> Text

FromHttpApiData ByteRanges

Methods

parseUrlPiece :: Text -> Either Text ByteRanges

parseHeader :: ByteString -> Either Text ByteRanges

parseQueryParam :: Text -> Either Text ByteRanges