fs

README

go-services-qingstor

fs services support for go-storage

Documentation

Overview

Package fs provided support for local file system.

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

Index

• Constants
• func NewStorager(pairs ...typ.Pair) (typ.Storager, error)
• type Storage
  • func (s *Storage) Copy(src string, dst string, pairs ...Pair) (err error)
  • func (s *Storage) CopyWithContext(ctx context.Context, src string, dst string, pairs ...Pair) (err error)
  • func (s *Storage) Delete(path string, pairs ...Pair) (err error)
  • func (s *Storage) DeleteWithContext(ctx context.Context, path string, pairs ...Pair) (err error)
  • func (s *Storage) ListDir(dir string, pairs ...Pair) (oi *ObjectIterator, err error)
  • func (s *Storage) ListDirWithContext(ctx context.Context, dir string, pairs ...Pair) (oi *ObjectIterator, err error)
  • func (s *Storage) Metadata(pairs ...Pair) (meta *StorageMeta, err error)
  • func (s *Storage) MetadataWithContext(ctx context.Context, pairs ...Pair) (meta *StorageMeta, err error)
  • func (s *Storage) Move(src string, dst string, pairs ...Pair) (err error)
  • func (s *Storage) MoveWithContext(ctx context.Context, src string, dst string, pairs ...Pair) (err error)
  • func (s *Storage) Read(path string, w io.Writer, pairs ...Pair) (n int64, err error)
  • func (s *Storage) ReadWithContext(ctx context.Context, path string, w io.Writer, pairs ...Pair) (n int64, err error)
  • func (s *Storage) Stat(path string, pairs ...Pair) (o *Object, err error)
  • func (s *Storage) StatWithContext(ctx context.Context, path string, pairs ...Pair) (o *Object, err error)
  • func (s *Storage) String() string
  • func (s *Storage) Write(path string, r io.Reader, pairs ...Pair) (n int64, err error)
  • func (s *Storage) WriteWithContext(ctx context.Context, path string, r io.Reader, pairs ...Pair) (n int64, err error)

Constants

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

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

Std{in/out/err} support

const Type = "fs"

Type is the type for fs

Functions

func NewStorager

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

NewStorager will create Storager only.

Types

type Storage

type Storage struct {
	// 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) 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) ListDir

func (s *Storage) ListDir(dir string, pairs ...Pair) (oi *ObjectIterator, err error)

ListDir will return list a specific dir.

This function will create a context by default.

func (*Storage) ListDirWithContext

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

ListDirWithContext will return list a specific dir.

func (*Storage) Metadata

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

Metadata will return current storager's 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's 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, pairs ...Pair) (n int64, err error)

Write will write data into a file.

This function will create a context by default.

func (*Storage) WriteWithContext

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

WriteWithContext will write data into a file.