# README
interface-go-ipfs-core
The CoreAPI interfaces for go-ipfs.
Lead Maintainer
Table of Contents
Documentation
TODO
Contribute
PRs are welcome!
Small note: If editing the Readme, please conform to the standard-readme specification.
License
MIT © Protocol Labs
# Constants
DiffAdd is set when a link was added to the graph.
DiffMod is set when a link was changed in the graph.
DiffRemove is set when a link was removed from the graph.
TDirectory is a directory.
TFile is a regular file.
TSymlink is a symlink.
TUnknown means the file type isn't known (e.g., it hasn't been resolved).
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
DirEntry is a directory entry returned by `Ls`.
No description provided by the author
ObjectChange represents a change ia a graph.
ObjectStat provides information about dag nodes.
# Interfaces
APIDagService extends ipld.DAGService.
BadPinNode is a node that has been marked as bad by Pin.Verify.
BlockAPI specifies the interface to the block layer.
BlockStat contains information about a block.
ConnectionInfo contains information about a peer.
CoreAPI defines an unified interface to IPFS for Go programs.
DhtAPI specifies the interface to the DHT Note: This API will likely get deprecated in near future, see https://github.com/ipfs/interface-ipfs-core/issues/249 for more context.
IpnsEntry specifies the interface to IpnsEntries.
Key specifies the interface to Keys in KeyAPI Keystore.
KeyAPI specifies the interface to Keystore.
NameAPI specifies the interface to IPNS.
ObjectAPI specifies the interface to MerkleDAG and contains useful utilities for manipulating MerkleDAG data structures.
Pin holds information about pinned resource.
PinAPI specifies the interface to pining.
PinStatus holds information about pin health.
PubSubAPI specifies the interface to PubSub.
PubSubMessage is a single PubSub message.
PubSubSubscription is an active PubSub subscription.
No description provided by the author
A ReadSeekCloser implements interfaces to read, copy, seek and close.
SwarmAPI specifies the interface to libp2p swarm.
UnixfsAPI is the basic interface to immutable files in IPFS NOTE: This API is heavily WIP, things are guaranteed to break frequently.
# Type aliases
ChangeType denotes type of change in ObjectChange.
FileType is an enum of possible UnixFS file types.