Documentation
¶
Overview ¶
IPFS is a global, versioned, peer-to-peer filesystem
There are sub-packages within the ipfs package for various low-level utilities, which are in turn assembled into:
core/...:
The low-level API that gives consumers all the knobs they need, which we try hard to keep stable.
shell/...:
The high-level API that gives consumers easy access to common operations (e.g. create a file node from a reader without wrapping with metadata). We work really hard to keep this stable.
Then on top of the core/... and shell/... Go APIs, we have:
cmd/...:
Command-line executables
test/...:
Integration tests, etc.
To avoid cyclic imports, imports should never pull in higher-level APIs into a lower-level package. For example, you could import all of core and shell from cmd/... or test/..., but you couldn't import any of shell from core/....
Directories
¶
Path | Synopsis |
---|---|
Godeps
|
|
_workspace/src/github.com/briantigerchow/pubsub
Package pubsub implements a simple multi-topic pub-sub library.
|
Package pubsub implements a simple multi-topic pub-sub library. |
_workspace/src/github.com/hashicorp/golang-lru
This package provides a simple LRU cache.
|
This package provides a simple LRU cache. |
_workspace/src/github.com/whyrusleeping/chunker
Package chunker implements Content Defined Chunking (CDC) based on a rolling Rabin Checksum.
|
Package chunker implements Content Defined Chunking (CDC) based on a rolling Rabin Checksum. |
Package blocks contains the lowest level of IPFS data structures.
|
Package blocks contains the lowest level of IPFS data structures. |
blockstore
Package blockstore implements a thin wrapper over a datastore, giving a clean interface for Getting and Putting block objects.
|
Package blockstore implements a thin wrapper over a datastore, giving a clean interface for Getting and Putting block objects. |
blockstore/util
Package blockstoreutil provides utility functions for Blockstores.
|
Package blockstoreutil provides utility functions for Blockstores. |
blocksutil
Package blocksutil provides utility functions for working with Blocks.
|
Package blocksutil provides utility functions for working with Blocks. |
bloom
Package bloom implements a simple bloom filter.
|
Package bloom implements a simple bloom filter. |
set
Package set defines the BlockSet interface which provides abstraction for sets of Cids.
|
Package set defines the BlockSet interface which provides abstraction for sets of Cids. |
package blockservice implements a BlockService interface that provides a single GetBlock/AddBlock interface that seamlessly retrieves data either locally or from a remote peer through the exchange.
|
package blockservice implements a BlockService interface that provides a single GetBlock/AddBlock interface that seamlessly retrieves data either locally or from a remote peer through the exchange. |
cmd
|
|
ipfs
cmd/ipfs implements the primary CLI binary for ipfs
|
cmd/ipfs implements the primary CLI binary for ipfs |
seccat
package main provides an implementation of netcat using the secio package.
|
package main provides an implementation of netcat using the secio package. |
Package core implements the IpfsNode object and related methods.
|
Package core implements the IpfsNode object and related methods. |
commands
Package commands implements the ipfs command interface
|
Package commands implements the ipfs command interface |
corehttp
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS.
|
Package corehttp provides utilities for the webui, gateways, and other high-level HTTP interfaces to IPFS. |
corerepo
Package corerepo provides pinning and garbage collection for local IPFS block services.
|
Package corerepo provides pinning and garbage collection for local IPFS block services. |
package diagnostics implements a network diagnostics service that allows a request to traverse the network and gather information on every node connected to it.
|
package diagnostics implements a network diagnostics service that allows a request to traverse the network and gather information on every node connected to it. |
pb
Package diagnostics_pb is a generated protocol buffer package.
|
Package diagnostics_pb is a generated protocol buffer package. |
package exchange defines the IPFS exchange interface
|
package exchange defines the IPFS exchange interface |
bitswap
package bitswap implements the IPFS exchange interface with the BitSwap bilateral exchange protocol.
|
package bitswap implements the IPFS exchange interface with the BitSwap bilateral exchange protocol. |
bitswap/decision
package decision implements the decision engine for the bitswap service.
|
package decision implements the decision engine for the bitswap service. |
bitswap/message/pb
Package bitswap_message_pb is a generated protocol buffer package.
|
Package bitswap_message_pb is a generated protocol buffer package. |
bitswap/wantlist
package wantlist implements an object for bitswap that contains the keys that a given peer wants.
|
package wantlist implements an object for bitswap that contains the keys that a given peer wants. |
offline
package offline implements an object that implements the exchange interface but returns nil values to every request.
|
package offline implements an object that implements the exchange interface but returns nil values to every request. |
Package filestore implements a Blockstore which is able to read certain blocks of data directly from its original location in the filesystem.
|
Package filestore implements a Blockstore which is able to read certain blocks of data directly from its original location in the filesystem. |
pb
Package datastore_pb is a generated protocol buffer package.
|
Package datastore_pb is a generated protocol buffer package. |
fuse
|
|
ipns
package fuse/ipns implements a fuse filesystem that interfaces with ipns, the naming system for ipfs.
|
package fuse/ipns implements a fuse filesystem that interfaces with ipns, the naming system for ipfs. |
mount
package mount provides a simple abstraction around a mount point
|
package mount provides a simple abstraction around a mount point |
readonly
package fuse/readonly implements a fuse filesystem to access files stored inside of ipfs.
|
package fuse/readonly implements a fuse filesystem to access files stored inside of ipfs. |
package importer implements utilities used to create IPFS DAGs from files and readers
|
package importer implements utilities used to create IPFS DAGs from files and readers |
chunk
package chunk implements streaming block splitters
|
package chunk implements streaming block splitters |
package merkledag implements the IPFS Merkle DAG datastructures.
|
package merkledag implements the IPFS Merkle DAG datastructures. |
pb
Package merkledag_pb is a generated protocol buffer package.
|
Package merkledag_pb is a generated protocol buffer package. |
traverse
Package traverse provides merkledag traversal functions
|
Package traverse provides merkledag traversal functions |
package mfs implements an in memory model of a mutable IPFS filesystem.
|
package mfs implements an in memory model of a mutable IPFS filesystem. |
Package namesys implements resolvers and publishers for the IPFS naming system (IPNS).
|
Package namesys implements resolvers and publishers for the IPFS naming system (IPNS). |
pb
Package namesys_pb is a generated protocol buffer package.
|
Package namesys_pb is a generated protocol buffer package. |
Package path implements utilities for resolving paths within ipfs.
|
Package path implements utilities for resolving paths within ipfs. |
package pin implements structures and methods to keep track of which objects a user wants to keep stored locally.
|
package pin implements structures and methods to keep track of which objects a user wants to keep stored locally. |
internal/pb
Package pb is a generated protocol buffer package.
|
Package pb is a generated protocol buffer package. |
config
package config implements the ipfs config file datastructures and utilities.
|
package config implements the ipfs config file datastructures and utilities. |
fsrepo
package fsrepo
|
package fsrepo |
routing
|
|
mock
Package mock provides a virtual routing server.
|
Package mock provides a virtual routing server. |
test
|
|
sharness/lib
package randomdep is here to introduce a dependency in random for godep to function properly.
|
package randomdep is here to introduce a dependency in random for godep to function properly. |
dependencies
Module
|
|
thirdparty
|
|
notifier
Package notifier provides a simple notification dispatcher meant to be embedded in larger structres who wish to allow clients to sign up for event notifications.
|
Package notifier provides a simple notification dispatcher meant to be embedded in larger structres who wish to allow clients to sign up for event notifications. |
pollEndpoint
pollEndpoint is a helper utility that waits for a http endpoint to be reachable and return with http.StatusOK
|
pollEndpoint is a helper utility that waits for a http endpoint to be reachable and return with http.StatusOK |
testutil/ci
Package ci implements some helper functions to use during tests.
|
Package ci implements some helper functions to use during tests. |
testutil/ci/travis
Package travis implements some helper functions to use during tests.
|
Package travis implements some helper functions to use during tests. |
Package format implements a data format for files in the IPFS filesystem It is not the only format in ipfs, but it is the one that the filesystem assumes
|
Package format implements a data format for files in the IPFS filesystem It is not the only format in ipfs, but it is the one that the filesystem assumes |
hamt
Package hamt implements a Hash Array Mapped Trie over ipfs merkledag nodes.
|
Package hamt implements a Hash Array Mapped Trie over ipfs merkledag nodes. |
io
package unixfs/io implements convenience objects for working with the ipfs unixfs data format.
|
package unixfs/io implements convenience objects for working with the ipfs unixfs data format. |
pb
Package unixfs_pb is a generated protocol buffer package.
|
Package unixfs_pb is a generated protocol buffer package. |
Click to show internal directories.
Click to hide internal directories.