Categorygithub.com/ipfs/interface-go-ipfs-core
modulepackage
0.11.2
Repository: https://github.com/ipfs/interface-go-ipfs-core.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
14
Dependents
174
Files
559 SLOC

# README

interface-go-ipfs-core

The CoreAPI interfaces for go-ipfs.

Coverage Status

ā— This repo is no longer maintained.

šŸ‘‰ We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/coreiface. šŸŽļø Good news! There is tooling and documentation to expedite a switch in your repo.

āš ļø If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).

šŸ“š Learn more, including how to take the maintainership mantle or ask questions, here.

Table of Contents

License

MIT Ā© Protocol Labs

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

FormatKey formats the given IPNS key in a canonical way.
Deprecated: use github.com/ipfs/boxo/coreiface.FormatKeyID.

# Constants

DiffAdd is set when a link was added to the graph Deprecated: use github.com/ipfs/boxo/coreiface.DiffAdd.
DiffMod is set when a link was changed in the graph Deprecated: use github.com/ipfs/boxo/coreiface.DiffMod.
DiffRemove is set when a link was removed from the graph Deprecated: use github.com/ipfs/boxo/coreiface.DiffRemove.
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

Deprecated: use github.com/ipfs/boxo/coreiface.ErrConnNotFound.
Deprecated: use github.com/ipfs/boxo/coreiface.ErrIsDir.
Deprecated: use github.com/ipfs/boxo/coreiface.ErrNotConnected.
Deprecated: use github.com/ipfs/boxo/coreiface.ErrNotFile.
Deprecated: use github.com/ipfs/boxo/coreiface.ErrNotSupported.
Deprecated: use github.com/ipfs/boxo/coreiface.ErrOffline.
Deprecated: use github.com/ipfs/boxo/coreiface.ErrResolveFailed.

# Structs

Deprecated: use github.com/ipfs/boxo/coreiface.AddEvent.
DirEntry is a directory entry returned by `Ls`.
Deprecated: use github.com/ipfs/boxo/coreiface.IpnsResult.
ObjectChange represents a change ia a graph Deprecated: use github.com/ipfs/boxo/coreiface.ObjectChange.
ObjectStat provides information about dag nodes Deprecated: use github.com/ipfs/boxo/coreiface.ObjectStat.

# Interfaces

APIDagService extends ipld.DAGService Deprecated: use github.com/ipfs/boxo/coreiface.APIDagService.
BadPinNode is a node that has been marked as bad by Pin.Verify Deprecated: use github.com/ipfs/boxo/coreiface.BadPinNode.
BlockAPI specifies the interface to the block layer Deprecated: use github.com/ipfs/boxo/coreiface.BlockAPI.
BlockStat contains information about a block Deprecated: use github.com/ipfs/boxo/coreiface.BlockStat.
ConnectionInfo contains information about a peer Deprecated: use github.com/ipfs/boxo/coreiface.ConnectionInfo.
CoreAPI defines an unified interface to IPFS for Go programs Deprecated: use github.com/ipfs/boxo/coreiface.CoreAPI.
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 Deprecated: use github.com/ipfs/boxo/coreiface.IpnsEntry.
Key specifies the interface to Keys in KeyAPI Keystore Deprecated: use github.com/ipfs/boxo/coreiface.Key.
KeyAPI specifies the interface to Keystore Deprecated: use github.com/ipfs/boxo/coreiface.KeyAPI.
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 Deprecated: use github.com/ipfs/boxo/coreiface.Pin.
PinAPI specifies the interface to pining Deprecated: use github.com/ipfs/boxo/coreiface.PinAPI.
PinStatus holds information about pin health Deprecated: use github.com/ipfs/boxo/coreiface.PinStatus.
PubSubAPI specifies the interface to PubSub Deprecated: use github.com/ipfs/boxo/coreiface.PubSubAPI.
PubSubMessage is a single PubSub message Deprecated: use github.com/ipfs/boxo/coreiface.PubSubMessage.
PubSubSubscription is an active PubSub subscription Deprecated: use github.com/ipfs/boxo/coreiface.PubSubSubscription.
Deprecated: use github.com/ipfs/boxo/coreiface.Reader.
A ReadSeekCloser implements interfaces to read, copy, seek and close.
RoutingAPI specifies the interface to the routing layer.
SwarmAPI specifies the interface to libp2p swarm Deprecated: use github.com/ipfs/boxo/coreiface.SwarmAPI.
UnixfsAPI is the basic interface to immutable files in IPFS NOTE: This API is heavily WIP, things are guaranteed to break frequently Deprecated: use github.com/ipfs/boxo/coreiface.UnixfsAPI.

# Type aliases

ChangeType denotes type of change in ObjectChange Deprecated: use github.com/ipfs/boxo/coreiface.ChangeType.
FileType is an enum of possible UnixFS file types.