fs

package module
v3.5.0 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2021 License: Apache-2.0 Imports: 19 Imported by: 3

README

Build Status License

go-services-fs

Local file system service support for go-storage.

Install

go get github.com/beyondstorage/go-service-fs/v3

Usage

import (
	"log"

	_ "github.com/beyondstorage/go-service-fs/v3"
	"github.com/beyondstorage/go-storage/v4/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 NewStorager 

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

NewStorager will create Storager only.

func WithDefaultStoragePairs 

func WithDefaultStoragePairs(v DefaultStoragePairs) Pair

WithDefaultStoragePairs will apply default_storage_pairs value to Options.

DefaultStoragePairs set default pairs for storager actions

func WithStorageFeatures added in v3.1.0 

func WithStorageFeatures(v StorageFeatures) Pair

WithStorageFeatures will apply storage_features value to Options.

StorageFeatures set storage features

Types

type DefaultStoragePairs 

type DefaultStoragePairs struct {
	CommitAppend []Pair
	Copy         []Pair
	Create       []Pair
	CreateAppend []Pair
	CreateDir    []Pair
	CreateLink   []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 ObjectSystemMetadata added in v3.2.0 

type ObjectSystemMetadata struct {
}

ObjectSystemMetadata stores system metadata for object.

func GetObjectSystemMetadata added in v3.2.0 

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

CommitAppend will commit and finish an append process.

This function will create a context by default.

func (*Storage) CommitAppendWithContext 

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

CommitAppendWithContext will commit and finish an append process.

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.

## Behavior

- Copy only copy one and only one object.

  • Service DON'T NEED to support copy a non-empty directory or copy files recursively.
  • User NEED to implement copy a non-empty directory and copy recursively by themself.
  • Copy a file to a directory SHOULD return `ErrObjectModeInvalid`.

- Copy SHOULD NOT return an error as dst object exists.

  • Service that has native support for `overwrite` doesn't NEED to check the dst object exists or not.
  • Service that doesn't have native support for `overwrite` SHOULD check and delete the dst object if exists.

- A successful copy opration should be complete, which means the dst object's content and metadata should be the same as src object.

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.

## Behavior

- Copy only copy one and only one object.

  • Service DON'T NEED to support copy a non-empty directory or copy files recursively.
  • User NEED to implement copy a non-empty directory and copy recursively by themself.
  • Copy a file to a directory SHOULD return `ErrObjectModeInvalid`.

- Copy SHOULD NOT return an error as dst object exists.

  • Service that has native support for `overwrite` doesn't NEED to check the dst object exists or not.
  • Service that doesn't have native support for `overwrite` SHOULD check and delete the dst object if exists.

- A successful copy opration should be complete, which means the dst object's content and metadata should be the same as src object.

func (*Storage) Create 

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

Create will create a new object without any api call.

## Behavior

- Create SHOULD NOT send any API call. - Create SHOULD accept ObjectMode pair as object mode.

This function will create a context by default.

func (*Storage) CreateAppend 

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

CreateAppend will create an append object.

## Behavior

- CreateAppend SHOULD create an appendable object with position 0 and size 0. - CreateAppend SHOULD NOT return an error as the object exist.

  • Service SHOULD check and delete the object if exists.

This function will create a context by default.

func (*Storage) CreateAppendWithContext 

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

CreateAppendWithContext will create an append object.

## Behavior

- CreateAppend SHOULD create an appendable object with position 0 and size 0. - CreateAppend SHOULD NOT return an error as the object exist.

  • Service SHOULD check and delete the object if exists.

func (*Storage) CreateDir 

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

CreateDir will create a new dir object.

This function will create a context by default.

func (*Storage) CreateDirWithContext 

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

CreateDirWithContext will create a new dir object. 

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

CreateLink Will create a link object.

Behavior

- `path` and `target` COULD be relative or absolute path. - If `target` not exists, CreateLink will still create a link object to path. - If `path` exists:

  • If `path` is a symlink object, CreateLink will remove the symlink object and create a new link object to path.
  • If `path` is not a symlink object, CreateLink will return an ErrObjectModeInvalid error when the service does not support overwrite.

- A link object COULD be returned in `Stat` or `List`. - CreateLink COULD implement virtual_link feature when service without native support.

  • Users SHOULD enable this feature by themselves.

This function will create a context by default.

func (*Storage) CreateLinkWithContext added in v3.4.0 

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

CreateLinkWithContext Will create a link object.

Behavior

- `path` and `target` COULD be relative or absolute path. - If `target` not exists, CreateLink will still create a link object to path. - If `path` exists:

  • If `path` is a symlink object, CreateLink will remove the symlink object and create a new link object to path.
  • If `path` is not a symlink object, CreateLink will return an ErrObjectModeInvalid error when the service does not support overwrite.

- A link object COULD be returned in `Stat` or `List`. - CreateLink COULD implement virtual_link feature when service without native support.

  • Users SHOULD enable this feature by themselves.

func (*Storage) Delete 

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

Delete will delete an object from service.

## Behavior

- Delete only delete one and only one object.

  • Service DON'T NEED to support remove all.
  • User NEED to implement remove_all by themself.

- Delete is idempotent.

  • Successful delete always return nil error.
  • Delete SHOULD never return `ObjectNotExist`
  • Delete DON'T NEED to check the object exist or not.

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.

## Behavior

- Delete only delete one and only one object.

  • Service DON'T NEED to support remove all.
  • User NEED to implement remove_all by themself.

- Delete is idempotent.

  • Successful delete always return nil error.
  • Delete SHOULD never return `ObjectNotExist`
  • Delete DON'T NEED to check the object exist or not.

func (*Storage) Fetch 

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

Fetch will fetch from a given url to path.

## Behavior

- Fetch SHOULD NOT return an error as the object exists. - A successful fetch operation should be complete, which means the object's content and metadata should be the same as requiring from the url.

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.

## Behavior

- Fetch SHOULD NOT return an error as the object exists. - A successful fetch operation should be complete, which means the object's content and metadata should be the same as requiring from the url.

func (*Storage) List 

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

List will return list a specific path.

## Behavior

- Service SHOULD support default `ListMode`. - Service SHOULD implement `ListModeDir` without the check for `VirtualDir`. - Service DON'T NEED to `Stat` while in `List`.

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.

## Behavior

- Service SHOULD support default `ListMode`. - Service SHOULD implement `ListModeDir` without the check for `VirtualDir`. - Service DON'T NEED to `Stat` while in `List`.

func (*Storage) Metadata 

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

Metadata will return current storager metadata.

This function will create a context by default.

func (*Storage) Move 

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

Move will move an object in the service.

## Behavior

- Move only move one and only one object.

  • Service DON'T NEED to support move a non-empty directory.
  • User NEED to implement move a non-empty directory by themself.
  • Move a file to a directory SHOULD return `ErrObjectModeInvalid`.

- Move SHOULD NOT return an error as dst object exists.

  • Service that has native support for `overwrite` doesn't NEED to check the dst object exists or not.
  • Service that doesn't have native support for `overwrite` SHOULD check and delete the dst object if exists.

- A successful move operation SHOULD be complete, which means the dst object's content and metadata should be the same as src object.

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.

## Behavior

- Move only move one and only one object.

  • Service DON'T NEED to support move a non-empty directory.
  • User NEED to implement move a non-empty directory by themself.
  • Move a file to a directory SHOULD return `ErrObjectModeInvalid`.

- Move SHOULD NOT return an error as dst object exists.

  • Service that has native support for `overwrite` doesn't NEED to check the dst object exists or not.
  • Service that doesn't have native support for `overwrite` SHOULD check and delete the dst object if exists.

- A successful move operation SHOULD be complete, which means the dst object's content and metadata should be the same as src object.

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.

## Behavior

- Stat SHOULD accept ObjectMode pair as hints.

  • Service COULD have different implementations for different object mode.
  • Service SHOULD check if returning ObjectMode is match

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.

## Behavior

- Stat SHOULD accept ObjectMode pair as hints.

  • Service COULD have different implementations for different object mode.
  • Service SHOULD check if returning ObjectMode is match

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.

## Behavior

- Write SHOULD NOT return an error as the object exist.

  • Service that has native support for `overwrite` doesn't NEED to check the object exists or not.
  • Service that doesn't have native support for `overwrite` SHOULD check and delete the object if exists.

- A successful write operation SHOULD be complete, which means the object's content and metadata should be the same as specified in write request.

This function will create a context by default.

func (*Storage) WriteAppend 

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 

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.

## Behavior

- Write SHOULD NOT return an error as the object exist.

  • Service that has native support for `overwrite` doesn't NEED to check the object exists or not.
  • Service that doesn't have native support for `overwrite` SHOULD check and delete the object if exists.

- A successful write operation SHOULD be complete, which means the object's content and metadata should be the same as specified in write request.

type StorageFeatures added in v3.1.0 

type StorageFeatures struct {
}

type StorageSystemMetadata added in v3.2.0 

type StorageSystemMetadata struct {
}

StorageSystemMetadata stores system metadata for storage meta.

func GetStorageSystemMetadata added in v3.2.0 

func GetStorageSystemMetadata(s *StorageMeta) StorageSystemMetadata

GetStorageSystemMetadata will get SystemMetadata from StorageMeta.

- The returning StorageSystemMetadata 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.