Network.IPFS.Types

Types related to IPFS

Documentation

newtype BinPath

Path to the IPFS binary

Constructors

BinPath

Fields

• getBinPath :: FilePath

Instances

FromJSON BinPath

Defined in Network.IPFS.BinPath.Types

Methods

parseJSON :: Value -> Parser BinPath

parseJSONList :: Value -> Parser [BinPath]

IsString BinPath

Defined in Network.IPFS.BinPath.Types

Methods

fromString :: String -> BinPath

Generic BinPath

Defined in Network.IPFS.BinPath.Types

Associated Types

type Rep BinPath :: Type -> Type

Methods

from :: BinPath -> Rep BinPath x

to :: Rep BinPath x -> BinPath

Show BinPath

Defined in Network.IPFS.BinPath.Types

Methods

showsPrec :: Int -> BinPath -> ShowS

show :: BinPath -> String

showList :: [BinPath] -> ShowS

FromEnv BinPath

Defined in Network.IPFS.BinPath.Types

Methods

fromEnv :: Maybe BinPath -> Parser BinPath

Eq BinPath

Defined in Network.IPFS.BinPath.Types

Methods

(==) :: BinPath -> BinPath -> Bool

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

Display BinPath

Defined in Network.IPFS.BinPath.Types

Methods

display :: BinPath -> Utf8Builder

textDisplay :: BinPath -> Text

type Rep BinPath

Defined in Network.IPFS.BinPath.Types

type Rep BinPath = D1 ('MetaData "BinPath" "Network.IPFS.BinPath.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'True) (C1 ('MetaCons "BinPath" 'PrefixI 'True) (S1 ('MetaSel ('Just "getBinPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

newtype CID

Constructors

CID

Fields

• unaddress :: Text

Instances

FromJSON CID

Defined in Network.IPFS.CID.Types

Methods

parseJSON :: Value -> Parser CID

parseJSONList :: Value -> Parser [CID]

ToJSON CID

Defined in Network.IPFS.CID.Types

Methods

toJSON :: CID -> Value

toEncoding :: CID -> Encoding

toJSONList :: [CID] -> Value

toEncodingList :: [CID] -> Encoding

IsString CID

Defined in Network.IPFS.CID.Types

Methods

fromString :: String -> CID

Generic CID

Defined in Network.IPFS.CID.Types

Associated Types

type Rep CID :: Type -> Type

Methods

from :: CID -> Rep CID x

to :: Rep CID x -> CID

Read CID

Defined in Network.IPFS.CID.Types

Methods

readsPrec :: Int -> ReadS CID

readList :: ReadS [CID]

readPrec :: ReadPrec CID

readListPrec :: ReadPrec [CID]

Show CID

Defined in Network.IPFS.CID.Types

Methods

showsPrec :: Int -> CID -> ShowS

show :: CID -> String

showList :: [CID] -> ShowS

Eq CID

Defined in Network.IPFS.CID.Types

Methods

(==) :: CID -> CID -> Bool

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

Ord CID

Defined in Network.IPFS.CID.Types

Methods

compare :: CID -> CID -> Ordering

(<) :: CID -> CID -> Bool

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

(>) :: CID -> CID -> Bool

(>=) :: CID -> CID -> Bool

max :: CID -> CID -> CID

min :: CID -> CID -> CID

FromHttpApiData CID

Defined in Network.IPFS.CID.Types

Methods

parseUrlPiece :: Text -> Either Text CID

parseHeader :: ByteString -> Either Text CID

parseQueryParam :: Text -> Either Text CID

ToHttpApiData CID

Defined in Network.IPFS.CID.Types

Methods

toUrlPiece :: CID -> Text

toEncodedUrlPiece :: CID -> Builder

toHeader :: CID -> ByteString

toQueryParam :: CID -> Text

Display CID

Defined in Network.IPFS.CID.Types

Methods

display :: CID -> Utf8Builder

textDisplay :: CID -> Text

ToParamSchema CID

Defined in Network.IPFS.CID.Types

Methods

toParamSchema :: forall (t :: SwaggerKind Type). Proxy CID -> ParamSchema t

ToSchema CID

Defined in Network.IPFS.CID.Types

Methods

declareNamedSchema :: Proxy CID -> Declare (Definitions Schema) NamedSchema

MimeRender OctetStream CID

Defined in Network.IPFS.CID.Types

Methods

mimeRender :: Proxy OctetStream -> CID -> ByteString

MimeRender PlainText CID

Defined in Network.IPFS.CID.Types

Methods

mimeRender :: Proxy PlainText -> CID -> ByteString

MimeUnrender PlainText CID

Defined in Network.IPFS.CID.Types

Methods

mimeUnrender :: Proxy PlainText -> ByteString -> Either String CID

mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String CID

MimeUnrender PlainText [CID]

Defined in Network.IPFS.CID.Types

Methods

mimeUnrender :: Proxy PlainText -> ByteString -> Either String [CID]

mimeUnrenderWithType :: Proxy PlainText -> MediaType -> ByteString -> Either String [CID]

type Rep CID

Defined in Network.IPFS.CID.Types

type Rep CID = D1 ('MetaData "CID" "Network.IPFS.CID.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'True) (C1 ('MetaCons "CID" 'PrefixI 'True) (S1 ('MetaSel ('Just "unaddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

mkCID :: Text -> CID

Smart constructor for CID

newtype Name

Constructors

Name

Fields

• unName :: String

Instances

FromJSON Name

Defined in Network.IPFS.Name.Types

Methods

parseJSON :: Value -> Parser Name

parseJSONList :: Value -> Parser [Name]

ToJSON Name

Defined in Network.IPFS.Name.Types

Methods

toJSON :: Name -> Value

toEncoding :: Name -> Encoding

toJSONList :: [Name] -> Value

toEncodingList :: [Name] -> Encoding

IsString Name

Defined in Network.IPFS.Name.Types

Methods

fromString :: String -> Name

Generic Name

Defined in Network.IPFS.Name.Types

Associated Types

type Rep Name :: Type -> Type

Methods

from :: Name -> Rep Name x

to :: Rep Name x -> Name

Show Name

Defined in Network.IPFS.Name.Types

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

Eq Name

Defined in Network.IPFS.Name.Types

Methods

(==) :: Name -> Name -> Bool

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

Ord Name

Defined in Network.IPFS.Name.Types

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

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

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

FromHttpApiData Name

Defined in Network.IPFS.Name.Types

Methods

parseUrlPiece :: Text -> Either Text Name

parseHeader :: ByteString -> Either Text Name

parseQueryParam :: Text -> Either Text Name

Display Name

Defined in Network.IPFS.Name.Types

Methods

display :: Name -> Utf8Builder

textDisplay :: Name -> Text

ToParamSchema Name

Defined in Network.IPFS.Name.Types

Methods

toParamSchema :: forall (t :: SwaggerKind Type). Proxy Name -> ParamSchema t

ToSchema Name

Defined in Network.IPFS.Name.Types

Methods

declareNamedSchema :: Proxy Name -> Declare (Definitions Schema) NamedSchema

type Rep Name

Defined in Network.IPFS.Name.Types

type Rep Name = D1 ('MetaData "Name" "Network.IPFS.Name.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'True) (C1 ('MetaCons "Name" 'PrefixI 'True) (S1 ('MetaSel ('Just "unName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

type Opt = String

type Command = String

type RawMessage = ByteString

newtype Peer

Constructors

Peer

Fields

• peer :: Text

Instances

FromJSON Peer

Defined in Network.IPFS.Peer.Types

Methods

parseJSON :: Value -> Parser Peer

parseJSONList :: Value -> Parser [Peer]

ToJSON Peer

Defined in Network.IPFS.Peer.Types

Methods

toJSON :: Peer -> Value

toEncoding :: Peer -> Encoding

toJSONList :: [Peer] -> Value

toEncodingList :: [Peer] -> Encoding

IsString Peer

Defined in Network.IPFS.Peer.Types

Methods

fromString :: String -> Peer

Show Peer

Defined in Network.IPFS.Peer.Types

Methods

showsPrec :: Int -> Peer -> ShowS

show :: Peer -> String

showList :: [Peer] -> ShowS

Eq Peer

Defined in Network.IPFS.Peer.Types

Methods

(==) :: Peer -> Peer -> Bool

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

Display Peer

Defined in Network.IPFS.Peer.Types

Methods

display :: Peer -> Utf8Builder

textDisplay :: Peer -> Text

ToSchema Peer

Defined in Network.IPFS.Peer.Types

Methods

declareNamedSchema :: Proxy Peer -> Declare (Definitions Schema) NamedSchema

MimeRender OctetStream Peer

Defined in Network.IPFS.Peer.Types

Methods

mimeRender :: Proxy OctetStream -> Peer -> ByteString

MimeRender PlainText Peer

Defined in Network.IPFS.Peer.Types

Methods

mimeRender :: Proxy PlainText -> Peer -> ByteString

newtype Path

CID path

Exmaple

"QmcaHAFzUPRCRaUK12dC6YyhcqEEtdfg94XrPwgCxZ1ihD/myfile.txt"

Constructors

Path

Fields

• unpath :: Text

Instances

IsString Path

Defined in Network.IPFS.Path.Types

Methods

fromString :: String -> Path

Generic Path

Defined in Network.IPFS.Path.Types

Associated Types

type Rep Path :: Type -> Type

Methods

from :: Path -> Rep Path x

to :: Rep Path x -> Path

Show Path

Defined in Network.IPFS.Path.Types

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

Eq Path

Defined in Network.IPFS.Path.Types

Methods

(==) :: Path -> Path -> Bool

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

Ord Path

Defined in Network.IPFS.Path.Types

Methods

compare :: Path -> Path -> Ordering

(<) :: Path -> Path -> Bool

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

(>) :: Path -> Path -> Bool

(>=) :: Path -> Path -> Bool

max :: Path -> Path -> Path

min :: Path -> Path -> Path

ToHttpApiData Path

Defined in Network.IPFS.Path.Types

Methods

toUrlPiece :: Path -> Text

toEncodedUrlPiece :: Path -> Builder

toHeader :: Path -> ByteString

toQueryParam :: Path -> Text

ToSchema Path

Defined in Network.IPFS.Path.Types

Methods

declareNamedSchema :: Proxy Path -> Declare (Definitions Schema) NamedSchema

MimeRender OctetStream Path

Defined in Network.IPFS.Path.Types

Methods

mimeRender :: Proxy OctetStream -> Path -> ByteString

MimeRender PlainText Path

Defined in Network.IPFS.Path.Types

Methods

mimeRender :: Proxy PlainText -> Path -> ByteString

type Rep Path

Defined in Network.IPFS.Path.Types

type Rep Path = D1 ('MetaData "Path" "Network.IPFS.Path.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'True) (C1 ('MetaCons "Path" 'PrefixI 'True) (S1 ('MetaSel ('Just "unpath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data SparseTree

Directory structure for CIDs and other identifiers

Examples:

Content "abcdef"

show $ Directory [(Key "abcdef", Stub "myfile.txt")])]

"abcdef/myfile.txt"

Constructors

Stub Name

Content CID

Directory (Map Tag SparseTree)

Instances

ToJSON SparseTree

Defined in Network.IPFS.SparseTree.Types

Methods

toJSON :: SparseTree -> Value

toEncoding :: SparseTree -> Encoding

toJSONList :: [SparseTree] -> Value

toEncodingList :: [SparseTree] -> Encoding

Generic SparseTree

Defined in Network.IPFS.SparseTree.Types

Associated Types

type Rep SparseTree :: Type -> Type

Methods

from :: SparseTree -> Rep SparseTree x

to :: Rep SparseTree x -> SparseTree

Show SparseTree

Defined in Network.IPFS.SparseTree.Types

Methods

showsPrec :: Int -> SparseTree -> ShowS

show :: SparseTree -> String

showList :: [SparseTree] -> ShowS

Eq SparseTree

Defined in Network.IPFS.SparseTree.Types

Methods

(==) :: SparseTree -> SparseTree -> Bool

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

Display SparseTree

Defined in Network.IPFS.SparseTree.Types

Methods

display :: SparseTree -> Utf8Builder

textDisplay :: SparseTree -> Text

ToSchema SparseTree

Defined in Network.IPFS.SparseTree.Types

Methods

declareNamedSchema :: Proxy SparseTree -> Declare (Definitions Schema) NamedSchema

Display (Map Tag SparseTree)

Defined in Network.IPFS.SparseTree.Types

Methods

display :: Map Tag SparseTree -> Utf8Builder

textDisplay :: Map Tag SparseTree -> Text

type Rep SparseTree

Defined in Network.IPFS.SparseTree.Types

type Rep SparseTree = D1 ('MetaData "SparseTree" "Network.IPFS.SparseTree.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'False) (C1 ('MetaCons "Stub" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)) :+: (C1 ('MetaCons "Content" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CID)) :+: C1 ('MetaCons "Directory" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Tag SparseTree)))))

data Tag

Constructors

Key Name

Hash CID

Instances

FromJSON Tag

Defined in Network.IPFS.SparseTree.Types

Methods

parseJSON :: Value -> Parser Tag

parseJSONList :: Value -> Parser [Tag]

FromJSONKey Tag

Defined in Network.IPFS.SparseTree.Types

Methods

fromJSONKey :: FromJSONKeyFunction Tag

fromJSONKeyList :: FromJSONKeyFunction [Tag]

ToJSON Tag

Defined in Network.IPFS.SparseTree.Types

Methods

toJSON :: Tag -> Value

toEncoding :: Tag -> Encoding

toJSONList :: [Tag] -> Value

toEncodingList :: [Tag] -> Encoding

ToJSONKey Tag

Defined in Network.IPFS.SparseTree.Types

Methods

toJSONKey :: ToJSONKeyFunction Tag

toJSONKeyList :: ToJSONKeyFunction [Tag]

Generic Tag

Defined in Network.IPFS.SparseTree.Types

Associated Types

type Rep Tag :: Type -> Type

Methods

from :: Tag -> Rep Tag x

to :: Rep Tag x -> Tag

Show Tag

Defined in Network.IPFS.SparseTree.Types

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

Eq Tag

Defined in Network.IPFS.SparseTree.Types

Methods

(==) :: Tag -> Tag -> Bool

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

Ord Tag

Defined in Network.IPFS.SparseTree.Types

Methods

compare :: Tag -> Tag -> Ordering

(<) :: Tag -> Tag -> Bool

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

(>) :: Tag -> Tag -> Bool

(>=) :: Tag -> Tag -> Bool

max :: Tag -> Tag -> Tag

min :: Tag -> Tag -> Tag

FromHttpApiData Tag

Defined in Network.IPFS.SparseTree.Types

Methods

parseUrlPiece :: Text -> Either Text Tag

parseHeader :: ByteString -> Either Text Tag

parseQueryParam :: Text -> Either Text Tag

Display Tag

Defined in Network.IPFS.SparseTree.Types

Methods

display :: Tag -> Utf8Builder

textDisplay :: Tag -> Text

ToSchema Tag

Defined in Network.IPFS.SparseTree.Types

Methods

declareNamedSchema :: Proxy Tag -> Declare (Definitions Schema) NamedSchema

Display (Map Tag SparseTree)

Defined in Network.IPFS.SparseTree.Types

Methods

display :: Map Tag SparseTree -> Utf8Builder

textDisplay :: Map Tag SparseTree -> Text

type Rep Tag

Defined in Network.IPFS.SparseTree.Types

type Rep Tag = D1 ('MetaData "Tag" "Network.IPFS.SparseTree.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'False) (C1 ('MetaCons "Key" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)) :+: C1 ('MetaCons "Hash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CID)))

newtype Timeout

Constructors

Timeout

Fields

• getSeconds :: Natural

Instances

FromJSON Timeout

Defined in Network.IPFS.Timeout.Types

Methods

parseJSON :: Value -> Parser Timeout

parseJSONList :: Value -> Parser [Timeout]

Generic Timeout

Defined in Network.IPFS.Timeout.Types

Associated Types

type Rep Timeout :: Type -> Type

Methods

from :: Timeout -> Rep Timeout x

to :: Rep Timeout x -> Timeout

Num Timeout

Defined in Network.IPFS.Timeout.Types

Methods

(+) :: Timeout -> Timeout -> Timeout

(-) :: Timeout -> Timeout -> Timeout

(*) :: Timeout -> Timeout -> Timeout

negate :: Timeout -> Timeout

abs :: Timeout -> Timeout

signum :: Timeout -> Timeout

fromInteger :: Integer -> Timeout

Show Timeout

Defined in Network.IPFS.Timeout.Types

Methods

showsPrec :: Int -> Timeout -> ShowS

show :: Timeout -> String

showList :: [Timeout] -> ShowS

FromEnv Timeout

Defined in Network.IPFS.Timeout.Types

Methods

fromEnv :: Maybe Timeout -> Parser Timeout

Eq Timeout

Defined in Network.IPFS.Timeout.Types

Methods

(==) :: Timeout -> Timeout -> Bool

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

type Rep Timeout

Defined in Network.IPFS.Timeout.Types

type Rep Timeout = D1 ('MetaData "Timeout" "Network.IPFS.Timeout.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'True) (C1 ('MetaCons "Timeout" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

newtype URL

IPFS client URL

Constructors

URL

Fields

• getURL :: BaseUrl

Instances

FromJSON URL

Defined in Network.IPFS.URL.Types

Methods

parseJSON :: Value -> Parser URL

parseJSONList :: Value -> Parser [URL]

Generic URL

Defined in Network.IPFS.URL.Types

Associated Types

type Rep URL :: Type -> Type

Methods

from :: URL -> Rep URL x

to :: Rep URL x -> URL

Show URL

Defined in Network.IPFS.URL.Types

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

Eq URL

Defined in Network.IPFS.URL.Types

Methods

(==) :: URL -> URL -> Bool

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

type Rep URL

Defined in Network.IPFS.URL.Types

type Rep URL = D1 ('MetaData "URL" "Network.IPFS.URL.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'True) (C1 ('MetaCons "URL" 'PrefixI 'True) (S1 ('MetaSel ('Just "getURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BaseUrl)))

type Ignored = [Pattern]

newtype Gateway

Type safety wrapper for IPFS Gateway Used as cname value for DNS updates

Constructors

Gateway

Fields

• getGateway :: Text

Instances

FromJSON Gateway

Defined in Network.IPFS.Gateway.Types

Methods

parseJSON :: Value -> Parser Gateway

parseJSONList :: Value -> Parser [Gateway]

IsString Gateway

Defined in Network.IPFS.Gateway.Types

Methods

fromString :: String -> Gateway

Generic Gateway

Defined in Network.IPFS.Gateway.Types

Associated Types

type Rep Gateway :: Type -> Type

Methods

from :: Gateway -> Rep Gateway x

to :: Rep Gateway x -> Gateway

Show Gateway

Defined in Network.IPFS.Gateway.Types

Methods

showsPrec :: Int -> Gateway -> ShowS

show :: Gateway -> String

showList :: [Gateway] -> ShowS

Eq Gateway

Defined in Network.IPFS.Gateway.Types

Methods

(==) :: Gateway -> Gateway -> Bool

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

ToSchema Gateway

Defined in Network.IPFS.Gateway.Types

Methods

declareNamedSchema :: Proxy Gateway -> Declare (Definitions Schema) NamedSchema

type Rep Gateway

Defined in Network.IPFS.Gateway.Types

type Rep Gateway = D1 ('MetaData "Gateway" "Network.IPFS.Gateway.Types" "ipfs-1.4.1-XZo7VmJWq1Gx4k7NhZfBV" 'True) (C1 ('MetaCons "Gateway" 'PrefixI 'True) (S1 ('MetaSel ('Just "getGateway") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ErrorBody

Constructors

ErrorBody

Fields

• message :: String

Instances

FromJSON ErrorBody

Defined in Network.IPFS.Client.Error.Types

Methods

parseJSON :: Value -> Parser ErrorBody

parseJSONList :: Value -> Parser [ErrorBody]

data Stat

Constructors

Stat

Fields

• blockSize :: Either OverflowDetected Bytes
• cumulativeSize :: Either OverflowDetected Bytes
• dataSize :: Either OverflowDetected Bytes
• hash :: Text
• linksSize :: Bytes
• numLinks :: Natural

Instances

FromJSON Stat

Defined in Network.IPFS.Stat.Types

Methods

parseJSON :: Value -> Parser Stat

parseJSONList :: Value -> Parser [Stat]

newtype Bytes

Constructors

Bytes

Fields

• unBytes :: Natural

Instances

FromJSON Bytes

Defined in Network.IPFS.Bytes.Types

Methods

parseJSON :: Value -> Parser Bytes

parseJSONList :: Value -> Parser [Bytes]

Show Bytes

Defined in Network.IPFS.Bytes.Types

Methods

showsPrec :: Int -> Bytes -> ShowS

show :: Bytes -> String

showList :: [Bytes] -> ShowS

Eq Bytes

Defined in Network.IPFS.Bytes.Types

Methods

(==) :: Bytes -> Bytes -> Bool

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