ipfs

package module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 24, 2021 License: Apache-2.0 Imports: 18 Imported by: 0

README

Services Test Ipfs

ipfs

InterPlanetary File System(IPFS) support for go-storage.

Install

go get go.beyondstorage.io/services/ipfs

Usage

import (
	"log"

	_ "go.beyondstorage.io/services/ipfs"
	"go.beyondstorage.io/v5/services"
)

func main() {
	store, err := services.NewStoragerFromString("ipfs:///path/to/workdir?endpoint=<ipfs_http_api_endpoint>&gateway=<ipfs_http_gateway>")
	if err != nil {
		log.Fatal(err)
	}
	
	// Write data from io.Reader into hello.txt
	n, err := store.Write("hello.txt", r, length)
}

Documentation

Overview

Package ipfs provided support for the InterPlanetary File System (IPFS).

Code generated by go generate via cmd/definitions; DO NOT EDIT.

Index

Constants

View Source 
const Type = "ipfs"

Type is the type for ipfs

Variables

This section is empty.

Functions

func NewStorager 

func NewStorager(pairs ...types.Pair) (types.Storager, error)

NewStorager will create Storager only.

func WithDefaultStoragePairs 

func WithDefaultStoragePairs(v DefaultStoragePairs) Pair

WithDefaultStoragePairs will apply default_storage_pairs value to Options.

set default pairs for storager actions

func WithGateway 

func WithGateway(v string) Pair

WithGateway will apply gateway value to Options.

set storage gateway, for http(s) request purpose

func WithStorageFeatures 

func WithStorageFeatures(v StorageFeatures) Pair

WithStorageFeatures will apply storage_features value to Options.

set storage features

Types

type DefaultStoragePairs 

type DefaultStoragePairs struct {
	Copy                []Pair
	Create              []Pair
	CreateDir           []Pair
	Delete              []Pair
	List                []Pair
	Metadata            []Pair
	Move                []Pair
	QuerySignHTTPDelete []Pair
	QuerySignHTTPRead   []Pair
	QuerySignHTTPWrite  []Pair
	Read                []Pair
	Stat                []Pair
	Write               []Pair
}

DefaultStoragePairs is default pairs for specific action

type ObjectSystemMetadata 

type ObjectSystemMetadata struct {
	Blocks         int
	CumulativeSize uint64
	Hash           string
	Local          bool
	SizeLocal      uint64
	WithLocality   bool
}

ObjectSystemMetadata stores system metadata for object.

func GetObjectSystemMetadata 

func GetObjectSystemMetadata(o *Object) ObjectSystemMetadata

GetObjectSystemMetadata will get ObjectSystemMetadata from Object.

- This function should not be called by service implementer. - The returning ObjectServiceMetadata is read only and should not be modified.

type Storage 

type Storage struct {
	types.UnimplementedStorager
	types.UnimplementedCopier
	types.UnimplementedMover
	types.UnimplementedDirer
	types.UnimplementedStorageHTTPSigner
	// contains filtered or unexported fields
}

Storage is the example client.

func (*Storage) Copy 

func (s *Storage) Copy(src string, dst string, pairs ...Pair) (err error)

func (*Storage) CopyWithContext 

func (s *Storage) CopyWithContext(ctx context.Context, src string, dst string, pairs ...Pair) (err error)

func (*Storage) Create 

func (s *Storage) Create(path string, pairs ...Pair) (o *Object)

func (*Storage) CreateDir 

func (s *Storage) CreateDir(path string, pairs ...Pair) (o *Object, err error)

func (*Storage) CreateDirWithContext 

func (s *Storage) CreateDirWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)

func (*Storage) Delete 

func (s *Storage) Delete(path string, pairs ...Pair) (err error)

func (*Storage) DeleteWithContext 

func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)

func (*Storage) List 

func (s *Storage) List(path string, pairs ...Pair) (oi *ObjectIterator, err error)

func (*Storage) ListWithContext 

func (s *Storage) ListWithContext(ctx context.Context, path string, pairs ...Pair) (oi *ObjectIterator, err error)

func (*Storage) Metadata 

func (s *Storage) Metadata(pairs ...Pair) (meta *StorageMeta)

func (*Storage) Move 

func (s *Storage) Move(src string, dst string, pairs ...Pair) (err error)

func (*Storage) MoveWithContext 

func (s *Storage) MoveWithContext(ctx context.Context, src string, dst string, pairs ...Pair) (err error)

func (*Storage) QuerySignHTTPDelete 

func (s *Storage) QuerySignHTTPDelete(path string, expire time.Duration, pairs ...Pair) (req *http.Request, err error)

func (*Storage) QuerySignHTTPDeleteWithContext 

func (s *Storage) QuerySignHTTPDeleteWithContext(ctx context.Context, path string, expire time.Duration, pairs ...Pair) (req *http.Request, err error)

func (*Storage) QuerySignHTTPRead 

func (s *Storage) QuerySignHTTPRead(path string, expire time.Duration, pairs ...Pair) (req *http.Request, err error)

func (*Storage) QuerySignHTTPReadWithContext 

func (s *Storage) QuerySignHTTPReadWithContext(ctx context.Context, path string, expire time.Duration, pairs ...Pair) (req *http.Request, err error)

func (*Storage) QuerySignHTTPWrite 

func (s *Storage) QuerySignHTTPWrite(path string, size int64, expire time.Duration, pairs ...Pair) (req *http.Request, err error)

func (*Storage) QuerySignHTTPWriteWithContext 

func (s *Storage) QuerySignHTTPWriteWithContext(ctx context.Context, path string, size int64, expire time.Duration, pairs ...Pair) (req *http.Request, err error)

func (*Storage) Read 

func (s *Storage) Read(path string, w io.Writer, pairs ...Pair) (n int64, err error)

func (*Storage) ReadWithContext 

func (s *Storage) ReadWithContext(ctx context.Context, path string, w io.Writer, pairs ...Pair) (n int64, err error)

func (*Storage) Stat 

func (s *Storage) Stat(path string, pairs ...Pair) (o *Object, err error)

func (*Storage) StatWithContext 

func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)

func (*Storage) String 

func (s *Storage) String() string

String implements Storager.String

func (*Storage) Write 

func (s *Storage) Write(path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)

func (*Storage) WriteWithContext 

func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, size int64, pairs ...Pair) (n int64, err error)

type StorageFeatures 

type StorageFeatures struct {
}

type StorageSystemMetadata 

type StorageSystemMetadata struct {
	Blocks         int
	CumulativeSize uint64
	Hash           string
	Local          bool
	SizeLocal      uint64
	WithLocality   bool
}

StorageSystemMetadata stores system metadata for object.

func GetStorageSystemMetadata 

func GetStorageSystemMetadata(s *StorageMeta) StorageSystemMetadata

GetStorageSystemMetadata will get StorageSystemMetadata from Storage.

- This function should not be called by service implementer. - The returning StorageServiceMetadata is read only and should not be modified.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.