storage

Documentation

Index

• func Copy(source Medium, sourcePath string, destination Medium, destinationPath string) core.Result
• type Medium
• type MemoryMedium
  • func NewMemoryMedium() *MemoryMedium
  • func (m *MemoryMedium) Append(path string) core.Result
  • func (m *MemoryMedium) Create(path string) core.Result
  • func (m *MemoryMedium) Delete(path string) core.Result
  • func (m *MemoryMedium) DeleteAll(path string) core.Result
  • func (m *MemoryMedium) EnsureDir(path string) core.Result
  • func (m *MemoryMedium) Exists(path string) bool
  • func (m *MemoryMedium) IsDir(path string) bool
  • func (m *MemoryMedium) IsFile(path string) bool
  • func (m *MemoryMedium) List(path string) core.Result
  • func (m *MemoryMedium) Open(path string) core.Result
  • func (m *MemoryMedium) Read(path string) core.Result
  • func (m *MemoryMedium) ReadStream(path string) core.Result
  • func (m *MemoryMedium) Rename(oldPath, newPath string) core.Result
  • func (m *MemoryMedium) Stat(path string) core.Result
  • func (m *MemoryMedium) Write(path, content string) core.Result
  • func (m *MemoryMedium) WriteMode(path string, content string, mode fs.FileMode) core.Result
  • func (m *MemoryMedium) WriteStream(path string) core.Result

Examples

• Copy
• MemoryMedium.Append
• MemoryMedium.Create
• MemoryMedium.Delete
• MemoryMedium.DeleteAll
• MemoryMedium.EnsureDir
• MemoryMedium.Exists
• MemoryMedium.IsDir
• MemoryMedium.IsFile
• MemoryMedium.List
• MemoryMedium.Open
• MemoryMedium.Read
• MemoryMedium.ReadStream
• MemoryMedium.Rename
• MemoryMedium.Stat
• MemoryMedium.Write
• MemoryMedium.WriteMode
• MemoryMedium.WriteStream
• NewMemoryMedium

Functions

func Copy

func Copy(source Medium, sourcePath string, destination Medium, destinationPath string) core.Result

Example

source := NewMemoryMedium()
_ = source.Write("in.txt", "value")
destination := NewMemoryMedium()
_ = Copy(source, "in.txt", destination, "out.txt")

Types

type Medium

type Medium interface {
	Read(path string) core.Result
	Write(path, content string) core.Result
	WriteMode(path, content string, mode fs.FileMode) core.Result
	EnsureDir(path string) core.Result
	IsFile(path string) bool
	Delete(path string) core.Result
	DeleteAll(path string) core.Result
	Rename(oldPath, newPath string) core.Result
	List(path string) core.Result
	Stat(path string) core.Result
	Open(path string) core.Result
	Create(path string) core.Result
	Append(path string) core.Result
	ReadStream(path string) core.Result
	WriteStream(path string) core.Result
	Exists(path string) bool
	IsDir(path string) bool
}

var Local Medium = localstore{}

type MemoryMedium

type MemoryMedium struct {
	// contains filtered or unexported fields
}

func NewMemoryMedium

func NewMemoryMedium() *MemoryMedium

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.Exists("file.txt")

func (*MemoryMedium) Append

func (m *MemoryMedium) Append(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Append("file.txt")
_ = medium.Exists("file.txt")

func (*MemoryMedium) Create

func (m *MemoryMedium) Create(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Create("file.txt")
_ = medium.Exists("file.txt")

func (*MemoryMedium) Delete

func (m *MemoryMedium) Delete(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.Delete("file.txt")

func (*MemoryMedium) DeleteAll

func (m *MemoryMedium) DeleteAll(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("dir/file.txt", "value")
_ = medium.DeleteAll("dir")

func (*MemoryMedium) EnsureDir

func (m *MemoryMedium) EnsureDir(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.EnsureDir("dir")
_ = medium.IsDir("dir")

func (*MemoryMedium) Exists

func (m *MemoryMedium) Exists(path string) bool

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.Exists("file.txt")

func (*MemoryMedium) IsDir

func (m *MemoryMedium) IsDir(path string) bool

Example

medium := NewMemoryMedium()
_ = medium.EnsureDir("dir")
_ = medium.IsDir("dir")

func (*MemoryMedium) IsFile

func (m *MemoryMedium) IsFile(path string) bool

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.IsFile("file.txt")

func (*MemoryMedium) List

func (m *MemoryMedium) List(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("dir/file.txt", "value")
_ = medium.List("dir")

func (*MemoryMedium) Open

func (m *MemoryMedium) Open(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.Open("file.txt")

func (*MemoryMedium) Read

func (m *MemoryMedium) Read(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.Read("file.txt")

func (*MemoryMedium) ReadStream

func (m *MemoryMedium) ReadStream(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.ReadStream("file.txt")

func (*MemoryMedium) Rename

func (m *MemoryMedium) Rename(oldPath, newPath string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("old.txt", "value")
_ = medium.Rename("old.txt", "new.txt")

func (*MemoryMedium) Stat

func (m *MemoryMedium) Stat(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.Stat("file.txt")

func (*MemoryMedium) Write

func (m *MemoryMedium) Write(path, content string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.Write("file.txt", "value")
_ = medium.Read("file.txt")

func (*MemoryMedium) WriteMode

func (m *MemoryMedium) WriteMode(path string, content string, mode fs.FileMode) core.Result

Example

medium := NewMemoryMedium()
_ = medium.WriteMode("file.txt", "value", 0o600)
_ = medium.Stat("file.txt")

func (*MemoryMedium) WriteStream

func (m *MemoryMedium) WriteStream(path string) core.Result

Example

medium := NewMemoryMedium()
_ = medium.WriteStream("file.txt")
_ = medium.Exists("file.txt")