web3-ipfs-1.0.0.0: IPFS support for Haskell Web3 library.
CopyrightAleksandr Krupenkin 2016-2021
LicenseApache-2.0
Maintainermail@akru.me
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Network.Ipfs.Api.Types

Description

IPFS API types.

Synopsis

Documentation

data DirLink Source #

Constructors

DirLink 

Instances

data DirObj Source #

Constructors

DirObj 

Fields

Instances

Instances details
Eq DirObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: DirObj -> DirObj -> Bool #

(/=) :: DirObj -> DirObj -> Bool #

Show DirObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON DirObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data AddObj Source #

Constructors

AddObj 

Fields

Instances

Instances details
Eq AddObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: AddObj -> AddObj -> Bool #

(/=) :: AddObj -> AddObj -> Bool #

Show AddObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON AddObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data LsObj Source #

Constructors

LsObj 

Fields

Instances

Instances details
Eq LsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: LsObj -> LsObj -> Bool #

(/=) :: LsObj -> LsObj -> Bool #

Show LsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

showsPrec :: Int -> LsObj -> ShowS #

show :: LsObj -> String #

showList :: [LsObj] -> ShowS #

FromJSON LsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data SwarmObj Source #

Constructors

SwarmObj 

Fields

Instances

Instances details
Eq SwarmObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show SwarmObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON SwarmObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data WantlistObj Source #

Constructors

WantlistObj 

Fields

Instances

Instances details
Eq WantlistObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show WantlistObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON WantlistObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data CidBasesObj Source #

Constructors

CidBasesObj 

Fields

Instances

Instances details
Eq CidBasesObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show CidBasesObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON CidBasesObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data CidObj Source #

Constructors

CidObj 

Fields

Instances

Instances details
Eq CidObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: CidObj -> CidObj -> Bool #

(/=) :: CidObj -> CidObj -> Bool #

Show CidObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON CidObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data BlockObj Source #

Constructors

BlockObj 

Fields

Instances

Instances details
Eq BlockObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show BlockObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON BlockObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data DagCidObj Source #

Constructors

DagCidObj 

Fields

Instances

Instances details
Eq DagCidObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show DagCidObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON DagCidObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data DagPutObj Source #

Constructors

DagPutObj 

Fields

Instances

Instances details
Eq DagPutObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show DagPutObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON DagPutObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data ConfigObj Source #

Constructors

ConfigObj 

Instances

Instances details
Eq ConfigObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show ConfigObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON ConfigObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data ObjectObj Source #

Constructors

ObjectObj 

Fields

Instances

Instances details
Eq ObjectObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show ObjectObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON ObjectObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data DiffObj Source #

Constructors

DiffObj 

Fields

Instances

Instances details
Eq DiffObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: DiffObj -> DiffObj -> Bool #

(/=) :: DiffObj -> DiffObj -> Bool #

Show DiffObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON DiffObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data PinObj Source #

Constructors

WithoutProgress 

Fields

WithProgress 

Fields

Instances

Instances details
Eq PinObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: PinObj -> PinObj -> Bool #

(/=) :: PinObj -> PinObj -> Bool #

Show PinObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON PinObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data StatsBwObj Source #

Constructors

StatsBwObj 

Instances

Instances details
Eq StatsBwObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show StatsBwObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON StatsBwObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data VersionObj Source #

Constructors

VersionObj 

Fields

Instances

Instances details
Eq VersionObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show VersionObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON VersionObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data IdObj Source #

Constructors

IdObj 

Instances

Instances details
Eq IdObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: IdObj -> IdObj -> Bool #

(/=) :: IdObj -> IdObj -> Bool #

Show IdObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

showsPrec :: Int -> IdObj -> ShowS #

show :: IdObj -> String #

showList :: [IdObj] -> ShowS #

FromJSON IdObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data DnsObj Source #

Constructors

DnsObj 

Fields

Instances

Instances details
Eq DnsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: DnsObj -> DnsObj -> Bool #

(/=) :: DnsObj -> DnsObj -> Bool #

Show DnsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON DnsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data PubsubObj Source #

Constructors

PubsubObj 

Fields

Instances

Instances details
Eq PubsubObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show PubsubObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON PubsubObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data LogLsObj Source #

Constructors

LogLsObj 

Fields

Instances

Instances details
Eq LogLsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show LogLsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON LogLsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data LogLevelObj Source #

Constructors

LogLevelObj 

Fields

Instances

Instances details
Eq LogLevelObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show LogLevelObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON LogLevelObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data RepoFsckObj Source #

Constructors

RepoFsckObj 

Fields

Instances

Instances details
Eq RepoFsckObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show RepoFsckObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON RepoFsckObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data KeyObj Source #

Constructors

KeyObj 

Fields

Instances

Instances details
Eq KeyObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Methods

(==) :: KeyObj -> KeyObj -> Bool #

(/=) :: KeyObj -> KeyObj -> Bool #

Show KeyObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON KeyObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data KeyRenameObj Source #

Constructors

KeyRenameObj 

Fields

data FilesLsObj Source #

Constructors

FilesLsObj 

Fields

Instances

Instances details
Eq FilesLsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

Show FilesLsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

FromJSON FilesLsObj Source # 
Instance details

Defined in Network.Ipfs.Api.Types

data IpfsText Source #

Defining a content type same as PlainText without charset

Instances

Instances details
Accept IpfsText Source # 
Instance details

Defined in Network.Ipfs.Api.Types

MimeUnrender IpfsText Text Source #
left show . TextS.decodeUtf8' . toStrict
Instance details

Defined in Network.Ipfs.Api.Types

data IpfsJSON Source #

Defining a content type same as IpfsJSON

Instances

Instances details
Accept IpfsJSON Source # 
Instance details

Defined in Network.Ipfs.Api.Types

MimeUnrender IpfsJSON Text Source #
left show . TextS.decodeUtf8' . toStrict
Instance details

Defined in Network.Ipfs.Api.Types

type IpfsApi = ("cat" :> (Capture "arg" Text :> Get '[IpfsText] CatReturnType)) :<|> (("ls" :> (Capture "arg" Text :> Get '[JSON] LsObj)) :<|> (("get" :> (Capture "arg" Text :> Get '[IpfsText] GetReturnType)) :<|> (("swarm" :> ("peers" :> Get '[JSON] SwarmPeersObj)) :<|> (("swarm" :> ("connect" :> (QueryParam "arg" Text :> Get '[JSON] SwarmObj))) :<|> (("swarm" :> ("disconnect" :> (QueryParam "arg" Text :> Get '[JSON] SwarmObj))) :<|> (("swarm" :> ("filters" :> Get '[JSON] SwarmObj)) :<|> (("swarm" :> ("filters" :> ("add" :> (QueryParam "arg" Text :> Get '[JSON] SwarmObj)))) :<|> (("swarm" :> ("filters" :> ("rm" :> (QueryParam "arg" Text :> Get '[JSON] SwarmObj)))) :<|> (("bitswap" :> ("stat" :> Get '[JSON] BitswapStatObj)) :<|> (("bitswap" :> ("wantlist" :> Get '[JSON] BitswapWLObj)) :<|> (("bitswap" :> ("ledger" :> (Capture "peerId" Text :> Get '[JSON] BitswapLedgerObj))) :<|> (("bitswap" :> ("reprovide" :> Get '[IpfsText] ReprovideReturnType)) :<|> (("cid" :> ("bases" :> Get '[JSON] [CidBasesObj])) :<|> (("cid" :> ("codecs" :> Get '[JSON] [CidCodecsObj])) :<|> (("cid" :> ("hashes" :> Get '[JSON] [CidHashesObj])) :<|> (("cid" :> ("base32" :> (Capture "cid" Text :> Get '[JSON] CidObj))) :<|> (("cid" :> ("format" :> (Capture "cid" Text :> Get '[JSON] CidObj))) :<|> (("block" :> ("get" :> (Capture "key" Text :> Get '[IpfsText] BlockReturnType))) :<|> (("block" :> ("stat" :> (Capture "key" Text :> Get '[JSON] BlockObj))) :<|> (("dag" :> ("get" :> (Capture "ref" Text :> Get '[IpfsJSON] DagReturnType))) :<|> (("dag" :> ("resolve" :> (Capture "ref" Text :> Get '[JSON] DagResolveObj))) :<|> (("config" :> (Capture "ref" Text :> Get '[JSON] ConfigObj)) :<|> (("config" :> (Capture "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] ConfigObj))) :<|> (("object" :> ("data" :> (Capture "ref" Text :> Get '[IpfsText] ObjectReturnType))) :<|> (("object" :> ("new" :> Get '[JSON] ObjectObj)) :<|> (("object" :> ("links" :> (Capture "ref" Text :> Get '[JSON] ObjectLinksObj))) :<|> (("object" :> ("patch" :> ("add-link" :> (Capture "arg" Text :> (QueryParam "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] ObjectLinksObj)))))) :<|> (("object" :> ("patch" :> ("rm-link" :> (Capture "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] ObjectLinksObj))))) :<|> (("object" :> ("get" :> (Capture "arg" Text :> Get '[JSON] ObjectGetObj))) :<|> (("object" :> ("diff" :> (Capture "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] ObjectDiffObj)))) :<|> (("object" :> ("stat" :> (Capture "arg" Text :> Get '[JSON] ObjectStatObj))) :<|> (("pin" :> ("add" :> (Capture "arg" Text :> Get '[JSON] PinObj))) :<|> (("pin" :> ("rm" :> (Capture "arg" Text :> Get '[JSON] PinObj))) :<|> (("bootstrap" :> ("add" :> (QueryParam "arg" Text :> Get '[JSON] BootstrapObj))) :<|> (("bootstrap" :> ("list" :> Get '[JSON] BootstrapObj)) :<|> (("bootstrap" :> ("rm" :> (QueryParam "arg" Text :> Get '[JSON] BootstrapObj))) :<|> (("stats" :> ("bw" :> Get '[JSON] StatsBwObj)) :<|> (("stats" :> ("repo" :> Get '[JSON] StatsRepoObj)) :<|> (("version" :> Get '[JSON] VersionObj) :<|> (("id" :> Get '[JSON] IdObj) :<|> (("id" :> (Capture "arg" Text :> Get '[JSON] IdObj)) :<|> (("dns" :> (Capture "arg" Text :> Get '[JSON] DnsObj)) :<|> (("pubsub" :> ("ls" :> Get '[JSON] PubsubObj)) :<|> (("pubsub" :> ("peers" :> Get '[JSON] PubsubObj)) :<|> (("pubsub" :> ("pub" :> (Capture "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] NoContent)))) :<|> (("log" :> ("ls" :> Get '[JSON] LogLsObj)) :<|> (("log" :> ("level" :> (Capture "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] LogLevelObj)))) :<|> (("repo" :> ("version" :> Get '[JSON] RepoVersionObj)) :<|> (("repo" :> ("fsck" :> Get '[JSON] RepoFsckObj)) :<|> (("key" :> ("gen" :> (Capture "arg" Text :> (QueryParam "type" Text :> Get '[JSON] KeyDetailsObj)))) :<|> (("key" :> ("list" :> Get '[JSON] KeyObj)) :<|> (("key" :> ("rename" :> (Capture "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] KeyRenameObj)))) :<|> (("key" :> ("rm" :> (Capture "arg" Text :> Get '[JSON] KeyObj))) :<|> (("files" :> ("chcid" :> (QueryParam "arg" Text :> (QueryParam "cid-version" Int :> Get '[JSON] NoContent)))) :<|> (("files" :> ("cp" :> (QueryParam "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] NoContent)))) :<|> (("files" :> ("flush" :> (QueryParam "arg" Text :> Get '[JSON] FilesFlushObj))) :<|> (("files" :> ("ls" :> (QueryParam "arg" Text :> Get '[JSON] FilesLsObj))) :<|> (("files" :> ("mkdir" :> (QueryParam "arg" Text :> Get '[JSON] NoContent))) :<|> (("files" :> ("mv" :> (QueryParam "arg" Text :> (QueryParam "arg" Text :> Get '[JSON] NoContent)))) :<|> (("files" :> ("read" :> (QueryParam "arg" Text :> Get '[IpfsText] FilesReadType))) :<|> (("files" :> ("rm" :> (QueryParam "arg" Text :> (QueryParam "recursive" Bool :> Get '[JSON] NoContent)))) :<|> (("files" :> ("stat" :> (QueryParam "arg" Text :> Get '[JSON] FilesStatObj))) :<|> ("shutdown" :> Get '[JSON] NoContent))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))))) Source #