Documentation
¶
Index ¶
Constants ¶
View Source
const ( PinHeader = "Pin" EncryptHeader = "Encrypt" IndexDocumentHeader = "Index-Document" ErrorDocumentHeader = "Error-Document" CollectionHeader = "Collection" CollectionNameHeader = "Collection-Name" ReferenceLinkHeader = "Reference-Link" // TargetsRecoveryHeader defines the Header for Recovery targets in Global Pinning TargetsRecoveryHeader = "recovery-targets" )
View Source
const (
StringTrue = "true"
)
Variables ¶
View Source
var ( ErrNotFound = errors.New("manifest: not found") ErrServerError = errors.New("manifest: ServerError") )
View Source
var BufferSizeMul int
Functions ¶
func UnescapeUnicode ¶
UnescapeUnicode convert the raw Unicode encoding to character
Types ¶
type AllRequest ¶
type AllResponse ¶
type ListResponse ¶ added in v1.1.2
type ListResponse struct {
RootCid boson.Address `json:"rootCid"`
PinState bool `json:"pinState"`
BitVector address.BitVectorApi `json:"bitVector"`
Register bool `json:"register"`
Manifest *fileinfo.ManifestNode `json:"manifest"`
}
type ManifestAction ¶ added in v1.2.1
type PageResponse ¶ added in v1.1.2
type PageResponse struct {
Total int `json:"total"`
List []ListResponse `json:"list"`
}
type RegisterResponse ¶ added in v1.1.2
type Service ¶
Service is the API service interface.
func New ¶
func New(storer storage.Storer, resolver resolver.Interface, addr boson.Address, chunkInfo chunkinfo.Interface, fileInfo fileinfo.Interface, traversalService traversal.Traverser, pinning pinning.Interface, auth authenticator, logger logging.Logger, kad topology.Driver, tracer *tracing.Tracer, traffic traffic.ApiInterface, commonChain chain.Common, oracleChain chain.Resolver, netRelay netrelay.NetRelay, multicast multicast.GroupInterface, route routetab.RouteTab, o Options) Service
New will create a and initialize a new API service.
type TransactionResponse ¶
type UpgradedResponseWriter ¶
type UpgradedResponseWriter interface {
http.ResponseWriter
http.Pusher
http.Hijacker
http.Flusher
http.CloseNotifier
}
UpgradedResponseWriter adds more functionality on top of ResponseWriter
type UploadResponse ¶ added in v1.1.2
UploadResponse is returned when an HTTP request to upload a file or collection is successful
Click to show internal directories.
Click to hide internal directories.