fileadapter

Documentation

Index

• type Adapter
  • func NewAdapter(filePath string) *Adapter
  • func (a *Adapter) AddPolicy(sec string, ptype string, rule []string) error
  • func (a *Adapter) LoadPolicy(model model.Model) error
  • func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error
  • func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error
  • func (a *Adapter) SavePolicy(model model.Model) error
• type AdapterMock
  • func NewAdapterMock(filePath string) *AdapterMock
  • func (a *AdapterMock) AddPolicy(sec string, ptype string, rule []string) error
  • func (a *AdapterMock) GetMockErr() error
  • func (a *AdapterMock) LoadPolicy(model model.Model) error
  • func (a *AdapterMock) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error
  • func (a *AdapterMock) RemovePolicy(sec string, ptype string, rule []string) error
  • func (a *AdapterMock) SavePolicy(model model.Model) error
  • func (a *AdapterMock) SetMockErr(errorToSet string)
• type Filter
• type FilteredAdapter
  • func NewFilteredAdapter(filePath string) *FilteredAdapter
  • func (a *FilteredAdapter) IsFiltered() bool
  • func (a *FilteredAdapter) LoadFilteredPolicy(model model.Model, filter interface{}) error
  • func (a *FilteredAdapter) LoadPolicy(model model.Model) error
  • func (a *FilteredAdapter) SavePolicy(model model.Model) error

Types

type Adapter

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

Adapter is the file adapter for Casbin. It can load policy from file or save policy to file.

func NewAdapter

func NewAdapter(filePath string) *Adapter

NewAdapter is the constructor for Adapter.

func (*Adapter) AddPolicy

func (a *Adapter) AddPolicy(sec string, ptype string, rule []string) error

AddPolicy adds a policy rule to the storage.

func (*Adapter) LoadPolicy

func (a *Adapter) LoadPolicy(model model.Model) error

LoadPolicy loads all policy rules from the storage.

func (*Adapter) RemoveFilteredPolicy

func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error

RemoveFilteredPolicy removes policy rules that match the filter from the storage.

func (*Adapter) RemovePolicy

func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error

RemovePolicy removes a policy rule from the storage.

func (*Adapter) SavePolicy

func (a *Adapter) SavePolicy(model model.Model) error

SavePolicy saves all policy rules to the storage.

type AdapterMock

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

AdapterMock is the file adapter for Casbin. It can load policy from file or save policy to file.

func NewAdapterMock

func NewAdapterMock(filePath string) *AdapterMock

NewAdapterMock is the constructor for AdapterMock.

func (*AdapterMock) AddPolicy

func (a *AdapterMock) AddPolicy(sec string, ptype string, rule []string) error

AddPolicy adds a policy rule to the storage.

func (*AdapterMock) GetMockErr

func (a *AdapterMock) GetMockErr() error

GetMockErr returns a mock error or nil

func (*AdapterMock) LoadPolicy

func (a *AdapterMock) LoadPolicy(model model.Model) error

LoadPolicy loads all policy rules from the storage.

func (*AdapterMock) RemoveFilteredPolicy

func (a *AdapterMock) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error

RemoveFilteredPolicy removes policy rules that match the filter from the storage.

func (*AdapterMock) RemovePolicy

func (a *AdapterMock) RemovePolicy(sec string, ptype string, rule []string) error

RemovePolicy removes a policy rule from the storage.

func (*AdapterMock) SavePolicy

func (a *AdapterMock) SavePolicy(model model.Model) error

SavePolicy saves all policy rules to the storage.

func (*AdapterMock) SetMockErr

func (a *AdapterMock) SetMockErr(errorToSet string)

SetMockErr sets string to be returned by of the mock during testing

type Filter

type Filter struct {
	P []string
	G []string
}

Filter defines the filtering rules for a FilteredAdapter's policy. Empty values are ignored, but all others must match the filter.

type FilteredAdapter

type FilteredAdapter struct {
	*Adapter
	// contains filtered or unexported fields
}

FilteredAdapter is the filtered file adapter for Casbin. It can load policy from file or save policy to file and supports loading of filtered policies.

func NewFilteredAdapter

func NewFilteredAdapter(filePath string) *FilteredAdapter

NewFilteredAdapter is the constructor for FilteredAdapter.

func (*FilteredAdapter) IsFiltered

func (a *FilteredAdapter) IsFiltered() bool

IsFiltered returns true if the loaded policy has been filtered.

func (*FilteredAdapter) LoadFilteredPolicy

func (a *FilteredAdapter) LoadFilteredPolicy(model model.Model, filter interface{}) error

LoadFilteredPolicy loads only policy rules that match the filter.

func (*FilteredAdapter) LoadPolicy

func (a *FilteredAdapter) LoadPolicy(model model.Model) error

LoadPolicy loads all policy rules from the storage.

func (*FilteredAdapter) SavePolicy

func (a *FilteredAdapter) SavePolicy(model model.Model) error

SavePolicy saves all policy rules to the storage.