Safe Haskell	None
Language	Haskell2010

Tahoe.Directory

Synopsis

parse :: ByteString -> Either (ParseErrorBundle ByteString Void) Directory
serialize :: Directory -> ByteString
data Entry = Entry {
- entryName :: Text
- entryReader :: ByteString
- entryEncryptedWriter :: ByteString
- entryMetadata :: ByteString
}
newtype Directory = Directory {
- directoryChildren :: [Entry]
}
newtype DirectoryCapability a = DirectoryCapability a
pVerifyCHK :: Parser (DirectoryCapability Verifier)
pReadCHK :: Parser (DirectoryCapability Reader)
pVerifySDMF :: Parser (DirectoryCapability Verifier)
pReadSDMF :: Parser (DirectoryCapability Reader)
pWriteSDMF :: Parser (DirectoryCapability Writer)

Documentation

parse :: ByteString -> Either (ParseErrorBundle ByteString Void) Directory Source #

Parse the serialized form of a directory into a Directory.

serialize :: Directory -> ByteString Source #

Serialize a Directory to the canonical bytes representation.

data Entry Source #

A reference to an object of any kind.

Constructors

Entry

Fields

entryName :: Text
The name of this entry in its containing directory. XXX What if UTF-8 decoding fails?
entryReader :: ByteString
A capability for reading the contents of this entry. XXX Structured cap instead
entryEncryptedWriter :: ByteString
An encrypted capability for performing writes to this entry. XXX Document the encryption scheme.
entryMetadata :: ByteString
Additional metadata about this entry such as last modification time. XXX How to represent this mixed type collection?

Instances

Instances details

Eq Entry Source #
Instance details Defined in Tahoe.Directory.Internal.Types Methods (==) :: Entry -> Entry -> Bool # (/=) :: Entry -> Entry -> Bool #
Show Entry Source #
Instance details Defined in Tahoe.Directory.Internal.Types Methods showsPrec :: Int -> Entry -> ShowS # show :: Entry -> String # showList :: [Entry] -> ShowS #

newtype Directory Source #

A collection of references to other objects.

Constructors

Directory
Fields directoryChildren :: [Entry]

Instances

Instances details

Eq Directory Source #
Instance details Defined in Tahoe.Directory.Internal.Types Methods (==) :: Directory -> Directory -> Bool # (/=) :: Directory -> Directory -> Bool #
Show Directory Source #
Instance details Defined in Tahoe.Directory.Internal.Types Methods showsPrec :: Int -> Directory -> ShowS # show :: Directory -> String # showList :: [Directory] -> ShowS #

newtype DirectoryCapability a Source #

A wrapper around some other capability type which signals that the plaintext is an encoded list of files.

Constructors

DirectoryCapability a

Instances

Instances details

Eq a => Eq (DirectoryCapability a) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods (==) :: DirectoryCapability a -> DirectoryCapability a -> Bool # (/=) :: DirectoryCapability a -> DirectoryCapability a -> Bool #
Ord a => Ord (DirectoryCapability a) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods compare :: DirectoryCapability a -> DirectoryCapability a -> Ordering # (<) :: DirectoryCapability a -> DirectoryCapability a -> Bool # (<=) :: DirectoryCapability a -> DirectoryCapability a -> Bool # (>) :: DirectoryCapability a -> DirectoryCapability a -> Bool # (>=) :: DirectoryCapability a -> DirectoryCapability a -> Bool # max :: DirectoryCapability a -> DirectoryCapability a -> DirectoryCapability a # min :: DirectoryCapability a -> DirectoryCapability a -> DirectoryCapability a #
Show a => Show (DirectoryCapability a) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods showsPrec :: Int -> DirectoryCapability a -> ShowS # show :: DirectoryCapability a -> String # showList :: [DirectoryCapability a] -> ShowS #
ConfidentialShowable (DirectoryCapability Reader) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods confidentiallyShow :: DirectoryCapability Reader -> Text
ConfidentialShowable (DirectoryCapability Verifier) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods confidentiallyShow :: DirectoryCapability Verifier -> Text
ConfidentialShowable (DirectoryCapability Reader) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods confidentiallyShow :: DirectoryCapability Reader -> Text
ConfidentialShowable (DirectoryCapability Verifier) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods confidentiallyShow :: DirectoryCapability Verifier -> Text
ConfidentialShowable (DirectoryCapability Writer) Source #
Instance details Defined in Tahoe.Directory.Internal.Capability Methods confidentiallyShow :: DirectoryCapability Writer -> Text

pVerifyCHK :: Parser (DirectoryCapability Verifier) Source #

Parse a CHK directory verifier capability.

The implementation is a cheesy hack that does string substitution on the input before applying the original CHK verifier parser.

pReadCHK :: Parser (DirectoryCapability Reader) Source #

Parse a CHK directory reader capability.

The implementation is a cheesy hack that does string substitution on the input before applying the original CHK reader parser.

pVerifySDMF :: Parser (DirectoryCapability Verifier) Source #

Parse an SDMF directory verifier capability. As is the case for the other directory capability parsers, the implementation is cheesy.

pReadSDMF :: Parser (DirectoryCapability Reader) Source #

Parse an SDMF directory reader capability. As is the case for the other directory capability parsers, the implementation is cheesy.

pWriteSDMF :: Parser (DirectoryCapability Writer) Source #

Parse an SDMF directory writer capability. As is the case for the other directory capability parsers, the implementation is cheesy.