Documentation ¶
Index ¶
- type Adapter
- func (a *Adapter) AddPolicies(sec string, ptype string, rules [][]string) error
- 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) RemovePolicies(sec string, ptype string, rules [][]string) error
- func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error
- func (a *Adapter) SavePolicy(model model.Model) error
- func (a *Adapter) UpdateFilteredPolicies(sec string, ptype string, newPolicies [][]string, fieldIndex int, ...) ([][]string, error)
- func (a *Adapter) UpdatePolicies(sec string, ptype string, oldRules, newRules [][]string) error
- func (a *Adapter) UpdatePolicy(sec string, ptype string, oldRule, newPolicy []string) error
- type AdapterMock
- func (a *AdapterMock) AddPolicies(sec string, ptype string, rules [][]string) error
- 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) RemovePolicies(sec string, ptype string, rules [][]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)
- func (a *AdapterMock) UpdatePolicies(sec string, ptype string, oldRules, newRules [][]string) error
- func (a *AdapterMock) UpdatePolicy(sec string, ptype string, oldRule, newPolicy []string) error
- type Filter
- type FilteredAdapter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 ¶
NewAdapter is the constructor for Adapter.
func (*Adapter) AddPolicies ¶ added in v2.2.2
AddPolicies adds policy rules to the storage.
func (*Adapter) LoadPolicy ¶
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) RemovePolicies ¶ added in v2.2.2
RemovePolicies removes policy rules from the storage.
func (*Adapter) RemovePolicy ¶
RemovePolicy removes a policy rule from the storage.
func (*Adapter) SavePolicy ¶
SavePolicy saves all policy rules to the storage.
func (*Adapter) UpdateFilteredPolicies ¶ added in v2.28.0
func (*Adapter) UpdatePolicies ¶ added in v2.22.0
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) AddPolicies ¶ added in v2.2.2
func (a *AdapterMock) AddPolicies(sec string, ptype string, rules [][]string) error
AddPolicies removes policy rules from the storage.
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) RemovePolicies ¶ added in v2.2.2
func (a *AdapterMock) RemovePolicies(sec string, ptype string, rules [][]string) error
RemovePolicies removes policy rules 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
func (*AdapterMock) UpdatePolicies ¶ added in v2.22.0
func (a *AdapterMock) UpdatePolicies(sec string, ptype string, oldRules, newRules [][]string) error
func (*AdapterMock) UpdatePolicy ¶ added in v2.14.0
func (a *AdapterMock) UpdatePolicy(sec string, ptype string, oldRule, newPolicy []string) error
UpdatePolicy removes a policy rule from the storage.
type Filter ¶
type Filter struct { P []string G []string G1 []string G2 []string G3 []string G4 []string G5 []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.