mockobject

Documentation

Overview

Package mockobject provides a mock object which can be created from a string

Index

• Variables
• type Object
  • func New(name string) Object
  • func (o Object) Fs() fs.Info
  • func (o Object) Hash(hash.Type) (string, error)
  • func (o Object) ModTime() (t time.Time)
  • func (o Object) Open(options ...fs.OpenOption) (io.ReadCloser, error)
  • func (o Object) Remote() string
  • func (o Object) Remove() error
  • func (o Object) SetModTime(time.Time) error
  • func (o Object) Size() int64
  • func (o Object) Storable() bool
  • func (o Object) String() string
  • func (o Object) Update(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) error
  • func (o Object) WithContent(content []byte, mode SeekMode) fs.Object
• type SeekMode
  • func (m SeekMode) String() string

Variables

var SeekModes = []SeekMode{SeekModeNone, SeekModeRegular, SeekModeRange}

SeekModes contains all valid SeekMode's

Types

type Object

type Object string

Object is a mock fs.Object useful for testing

func New

func New(name string) Object

New returns mock fs.Object useful for testing

func (Object) Fs

func (o Object) Fs() fs.Info

Fs returns read only access to the Fs that this object is part of

func (Object) Hash

func (o Object) Hash(hash.Type) (string, error)

Hash returns the selected checksum of the file If no checksum is available it returns ""

func (Object) ModTime

func (o Object) ModTime() (t time.Time)

ModTime returns the modification date of the file It should return a best guess if one isn't available

func (Object) Open

func (o Object) Open(options ...fs.OpenOption) (io.ReadCloser, error)

Open opens the file for read. Call Close() on the returned io.ReadCloser

func (Object) Remote

func (o Object) Remote() string

Remote returns the remote path

func (Object) Remove

func (o Object) Remove() error

Remove this object

func (Object) SetModTime

func (o Object) SetModTime(time.Time) error

SetModTime sets the metadata on the object to set the modification date

func (Object) Size

func (o Object) Size() int64

Size returns the size of the file

func (Object) Storable

func (o Object) Storable() bool

Storable says whether this object can be stored

func (Object) String

func (o Object) String() string

String returns a description of the Object

func (Object) Update

func (o Object) Update(in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) error

Update in to the object with the modTime given of the given size

func (Object) WithContent

func (o Object) WithContent(content []byte, mode SeekMode) fs.Object

WithContent returns a fs.Object with the given content.

type SeekMode

type SeekMode int

SeekMode specifies the optional Seek interface for the ReadCloser returned by Open

const (
	// SeekModeNone specifies no seek interface
	SeekModeNone SeekMode = iota
	// SeekModeRegular specifies the regular io.Seek interface
	SeekModeRegular
	// SeekModeRange specifies the fs.RangeSeek interface
	SeekModeRange
)

func (SeekMode) String

func (m SeekMode) String() string