fs

package
v0.0.0-...-0dabf1d Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2023 License: Apache-2.0, Apache-2.0 Imports: 23 Imported by: 0

README

Services Test Fs

fs

Local file system service support for go-storage.

Install

go get go.beyondstorage.io/services/fs/v4

Usage

import (
	"log"

	_ "go.beyondstorage.io/services/fs/v4"
	"github.com/fastone-open/go-storage/services"
)

func main() {
	store, err := services.NewStoragerFromString("fs:///path/to/workdir")
	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 fs provided support for local file system.

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

Index

Constants

View Source 
const (
	// The file type is unknown.
	DirentTypeUnknown = 0
	// This is a named pipe (FIFO).
	DirentTypeFIFO = 1
	// This is a character device.
	DirentTypeCharDevice = 2
	// This is a directory.
	DirentTypeDirectory = 4
	// This is a block device.
	DirentTypeBlockDevice = 6
	// This is a regular file.
	DirentTypeRegular = 8
	// This is a symbolic link.
	DirentTypeLink = 10
	// This is a UNIX domain socket.
	DirentTypeSocket = 12
	// WhiteOut from BSD, don't know what's it mean.
	DirentTypeWhiteOut = 14
)

Available value for Dirent Type

Copied from linux kernel <dirent.h> #define DT_UNKNOWN 0 #define DT_FIFO 1 #define DT_CHR 2 #define DT_DIR 4 #define DT_BLK 6 #define DT_REG 8 #define DT_LNK 10 #define DT_SOCK 12 #define DT_WHT 14

View Source 
const (
	Stdin  = "/dev/stdin"
	Stdout = "/dev/stdout"
	Stderr = "/dev/stderr"
)

Std{in/out/err} support

View Source 
const Type = "fs"

Type is the type for fs

Variables

This section is empty.

Functions

func NewServicer 

func NewServicer(pairs ...typ.Pair) (typ.Servicer, error)

NewServicer will create Servicer only.

func NewStorager 

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

NewStorager will create Storager only.

func WithDefaultServicePairs 

func WithDefaultServicePairs(v DefaultServicePairs) Pair

WithDefaultServicePairs will apply default_service_pairs value to Options.

func WithDefaultStoragePairs 

func WithDefaultStoragePairs(v DefaultStoragePairs) Pair

WithDefaultStoragePairs will apply default_storage_pairs value to Options.

func WithServiceFeatures 

func WithServiceFeatures(v ServiceFeatures) Pair

WithServiceFeatures will apply service_features value to Options.

func WithStorageFeatures 

func WithStorageFeatures(v StorageFeatures) Pair

WithStorageFeatures will apply storage_features value to Options.

Types

type ObjectSystemMetadata 

type ObjectSystemMetadata struct {
}

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 Service 

type Service struct {
	typ.UnimplementedServicer

	sync.RWMutex
	// contains filtered or unexported fields
}

Service is the qingstor service config.

func (*Service) Create 

func (s *Service) Create(name string, pairs ...Pair) (store Storager, err error)

func (*Service) CreateWithContext 

func (s *Service) CreateWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)

func (*Service) Delete 

func (s *Service) Delete(name string, pairs ...Pair) (err error)

func (*Service) DeleteWithContext 

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

func (*Service) Get 

func (s *Service) Get(name string, pairs ...Pair) (store Storager, err error)

func (*Service) GetWithContext 

func (s *Service) GetWithContext(ctx context.Context, name string, pairs ...Pair) (store Storager, err error)

func (*Service) List 

func (s *Service) List(pairs ...Pair) (sti *StoragerIterator, err error)

func (*Service) ListWithContext 

func (s *Service) ListWithContext(ctx context.Context, pairs ...Pair) (sti *StoragerIterator, err error)

func (*Service) String 

func (s *Service) String() string

String implements Service.String.

type Storage 

type Storage struct {
	typ.UnimplementedStorager
	typ.UnimplementedCopier
	typ.UnimplementedMover
	typ.UnimplementedFetcher
	typ.UnimplementedAppender
	typ.UnimplementedDirer
	typ.UnimplementedLinker
	// contains filtered or unexported fields
}

Storage is the fs client.

func (*Storage) CommitAppend 

func (s *Storage) CommitAppend(o *Object, pairs ...Pair) (err error)

func (*Storage) CommitAppendWithContext 

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

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) CreateAppend 

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

func (*Storage) CreateAppendWithContext 

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

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 (s *Storage) CreateLink(path string, target string, pairs ...Pair) (o *Object, err error)

func (*Storage) CreateLinkWithContext 

func (s *Storage) CreateLinkWithContext(ctx context.Context, path string, target 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) Fetch 

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

func (*Storage) FetchWithContext 

func (s *Storage) FetchWithContext(ctx context.Context, path string, url 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) 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) WriteAppend 

func (s *Storage) WriteAppend(o *Object, r io.Reader, size int64, pairs ...Pair) (n int64, err error)

func (*Storage) WriteAppendWithContext 

func (s *Storage) WriteAppendWithContext(ctx context.Context, o *Object, 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 StorageSystemMetadata 

type StorageSystemMetadata struct {
}

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.