fs

package module
v2.1.0 Latest Latest
Warning

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

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

README

go-services-fs

Build Status License go storage dev

fs services support for go-storage

Install

go get github.com/aos-dev/go-service-fs/v2

Documentation

Overview

Package fs provided support for local file system.

Code generated by go generate via internal/cmd/service; 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 (
	// Std{in/out/err} support
	Stdin  = "/dev/stdin"
	Stdout = "/dev/stdout"
	Stderr = "/dev/stderr"

	PathSeparator = string(filepath.Separator)
)
View Source 
const Type = "fs"

Type is the type for fs

Variables

This section is empty.

Functions

func NewStorager 

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

NewStorager will create Storager only.

func WithDefaultStoragePairs added in v2.1.0 

func WithDefaultStoragePairs(v DefaultStoragePairs) Pair

WithDefaultStoragePairs will apply default_storage_pairs value to Options DefaultStoragePairs set default pairs for storager actions

Types

type DefaultStoragePairs added in v2.1.0 

type DefaultStoragePairs struct {
	Copy         []Pair
	Create       []Pair
	CreateAppend []Pair
	Delete       []Pair
	Fetch        []Pair
	List         []Pair
	Metadata     []Pair
	Move         []Pair
	Read         []Pair
	Stat         []Pair
	Write        []Pair
	WriteAppend  []Pair
}

DefaultStoragePairs is default pairs for specific action

type ObjectMetadata added in v2.1.0 

type ObjectMetadata struct {
}

ObjectMetadata stores service metadata for object.

func GetObjectMetadata added in v2.1.0 

func GetObjectMetadata(o *Object) ObjectMetadata

GetObjectMetadata will get ObjectMetadata from Object.

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

type Storage 

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

Storage is the fs client.

func (*Storage) Copy 

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

Copy will copy an Object or multiple object in the service.

This function will create a context by default.

func (*Storage) CopyWithContext 

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

CopyWithContext will copy an Object or multiple object in the service.

func (*Storage) Create added in v2.1.0 

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

Create will create a new object without any api call.

This function will create a context by default.

func (*Storage) CreateAppend added in v2.1.0 

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

CreateAppend will create an append object.

This function will create a context by default.

func (*Storage) CreateAppendWithContext added in v2.1.0 

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

CreateAppendWithContext will create an append object.

func (*Storage) Delete 

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

Delete will delete an Object from service.

This function will create a context by default.

func (*Storage) DeleteWithContext 

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

DeleteWithContext will delete an Object from service.

func (*Storage) Fetch 

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

Fetch will fetch from a given url to path.

This function will create a context by default.

func (*Storage) FetchWithContext 

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

FetchWithContext will fetch from a given url to path.

func (*Storage) List 

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

List will return list a specific path.

This function will create a context by default.

func (*Storage) ListWithContext 

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

ListWithContext will return list a specific path.

func (*Storage) Metadata 

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

Metadata will return current storager metadata.

This function will create a context by default.

func (*Storage) MetadataWithContext 

func (s *Storage) MetadataWithContext(ctx context.Context, pairs ...Pair) (meta *StorageMeta, err error)

MetadataWithContext will return current storager metadata.

func (*Storage) Move 

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

Move will move an object in the service.

This function will create a context by default.

func (*Storage) MoveWithContext 

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

MoveWithContext will move an object in the service.

func (*Storage) Read 

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

Read will read the file's data.

This function will create a context by default.

func (*Storage) ReadWithContext 

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

ReadWithContext will read the file's data.

func (*Storage) Stat 

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

Stat will stat a path to get info of an object.

This function will create a context by default.

func (*Storage) StatWithContext 

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

StatWithContext will stat a path to get info of an object.

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)

Write will write data into a file.

This function will create a context by default.

func (*Storage) WriteAppend added in v2.1.0 

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

WriteAppend will append content to an append object.

This function will create a context by default.

func (*Storage) WriteAppendWithContext added in v2.1.0 

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

WriteAppendWithContext will append content to an append object.

func (*Storage) WriteWithContext 

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

WriteWithContext will write data into a file.

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.