fs

Documentation

Index

• Variables
• type Fs
  • func New(mock afero.Fs) *Fs
  • func (fs Fs) CreateGroup(name string, initVault []byte) error
  • func (fs Fs) Delete(ctx context.Context, gid string) error
  • func (fs Fs) GroupExists(name string) error
  • func (fs Fs) InitFs(initVault []byte) error
  • func (fs Fs) ReadGroupVault(group string) ([]byte, error)
  • func (fs Fs) ReadRegisteredGroups() ([]string, error)
  • func (fs Fs) VaultExists(group string) error
  • func (fs Fs) Write(ctx context.Context, gid string, data []byte) error

Variables

var (
	ErrNoSuchGroup = fmt.Errorf("group not found in sherlock")
	ErrNoSuchVault = fmt.Errorf("vault for group not found in sherlock")
	ErrGroupExists = fmt.Errorf("group already exists")
)

Types

type Fs

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

func New

func New(mock afero.Fs) *Fs

func (Fs) CreateGroup

func (fs Fs) CreateGroup(name string, initVault []byte) error

CreateGroup creates a new directory for a given group with its .vault file. if the group already exists it will be overwritten! To check if a group exists you should use the fs.GroupExists func

func (Fs) Delete

func (fs Fs) Delete(ctx context.Context, gid string) error

Delete removes the passed in group directory irreversible from sherlock

func (Fs) GroupExists

func (fs Fs) GroupExists(name string) error

func (Fs) InitFs

func (fs Fs) InitFs(initVault []byte) error

InitFs creates all directories required to be setup to use sherlock. If the directory exists nothing happens

func (Fs) ReadGroupVault

func (fs Fs) ReadGroupVault(group string) ([]byte, error)

ReadVault reads the stored .vault file

func (Fs) ReadRegisteredGroups

func (fs Fs) ReadRegisteredGroups() ([]string, error)

Read All Groups Saved

func (Fs) VaultExists

func (fs Fs) VaultExists(group string) error

func (Fs) Write

func (fs Fs) Write(ctx context.Context, gid string, data []byte) error