fileadapter

package
v2.135.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 9, 2025 License: Apache-2.0 Imports: 10 Imported by: 75

Documentation

Index

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 

func NewAdapter(filePath string) *Adapter

NewAdapter is the constructor for Adapter.

func (*Adapter) AddPolicies added in v2.2.2 

func (a *Adapter) AddPolicies(sec string, ptype string, rules [][]string) error

AddPolicies adds policy rules to the storage.

func (*Adapter) AddPoliciesCtx added in v2.128.0 

func (a *Adapter) AddPoliciesCtx(ctx context.Context, sec string, ptype string, rules [][]string) error

AddPoliciesCtx adds policy rules to the storage with context.

func (*Adapter) AddPolicy 

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

AddPolicy adds a policy rule to the storage.

func (*Adapter) AddPolicyCtx added in v2.128.0 

func (a *Adapter) AddPolicyCtx(ctx context.Context, sec string, ptype string, rule []string) error

AddPolicyCtx adds a policy rule to the storage with context.

func (*Adapter) LoadPolicy 

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

LoadPolicy loads all policy rules from the storage.

func (*Adapter) LoadPolicyCtx added in v2.128.0 

func (a *Adapter) LoadPolicyCtx(ctx context.Context, model model.Model) error

LoadPolicyCtx loads all policy rules from the storage with context.

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) RemoveFilteredPolicyCtx added in v2.128.0 

func (a *Adapter) RemoveFilteredPolicyCtx(ctx context.Context, sec string, ptype string, fieldIndex int, fieldValues ...string) error

RemoveFilteredPolicyCtx removes policy rules that match the filter from the storage with context.

func (*Adapter) RemovePolicies added in v2.2.2 

func (a *Adapter) RemovePolicies(sec string, ptype string, rules [][]string) error

RemovePolicies removes policy rules from the storage.

func (*Adapter) RemovePoliciesCtx added in v2.128.0 

func (a *Adapter) RemovePoliciesCtx(ctx context.Context, sec string, ptype string, rules [][]string) error

RemovePoliciesCtx removes policy rules from the storage with context.

func (*Adapter) RemovePolicy 

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

RemovePolicy removes a policy rule from the storage.

func (*Adapter) RemovePolicyCtx added in v2.128.0 

func (a *Adapter) RemovePolicyCtx(ctx context.Context, sec string, ptype string, rule []string) error

RemovePolicyCtx removes a policy rule from the storage with context.

func (*Adapter) SavePolicy 

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

SavePolicy saves all policy rules to the storage.

func (*Adapter) SavePolicyCtx added in v2.128.0 

func (a *Adapter) SavePolicyCtx(ctx context.Context, model model.Model) error

SavePolicyCtx saves all policy rules to the storage with context.

func (*Adapter) UpdateFilteredPolicies added in v2.28.0 

func (a *Adapter) UpdateFilteredPolicies(sec string, ptype string, newRules [][]string, fieldIndex int, fieldValues ...string) ([][]string, error)

func (*Adapter) UpdateFilteredPoliciesCtx added in v2.128.0 

func (a *Adapter) UpdateFilteredPoliciesCtx(ctx context.Context, sec string, ptype string, newRules [][]string, fieldIndex int, fieldValues ...string) ([][]string, error)

func (*Adapter) UpdatePolicies added in v2.22.0 

func (a *Adapter) UpdatePolicies(sec string, ptype string, oldRules, newRules [][]string) error

func (*Adapter) UpdatePoliciesCtx added in v2.128.0 

func (a *Adapter) UpdatePoliciesCtx(ctx context.Context, sec string, ptype string, oldRules, newRules [][]string) error

func (*Adapter) UpdatePolicy added in v2.14.0 

func (a *Adapter) UpdatePolicy(sec string, ptype string, oldRule, newRule []string) error

func (*Adapter) UpdatePolicyCtx added in v2.128.0 

func (a *Adapter) UpdatePolicyCtx(ctx context.Context, sec string, ptype string, oldRule, newRule []string) error

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) IsFilteredCtx added in v2.128.0 

func (a *FilteredAdapter) IsFilteredCtx(ctx context.Context) bool

IsFilteredCtx returns true if the loaded policy has been filtered with context.

func (*FilteredAdapter) LoadFilteredPolicy 

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

LoadFilteredPolicy loads only policy rules that match the filter.

func (*FilteredAdapter) LoadFilteredPolicyCtx added in v2.128.0 

func (a *FilteredAdapter) LoadFilteredPolicyCtx(ctx context.Context, model model.Model, filter interface{}) error

LoadFilteredPolicyCtx loads only policy rules that match the filter with context.

func (*FilteredAdapter) LoadPolicy 

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

LoadPolicy loads all policy rules from the storage.

func (*FilteredAdapter) LoadPolicyCtx added in v2.128.0 

func (a *FilteredAdapter) LoadPolicyCtx(ctx context.Context, model model.Model) error

LoadPolicyCtx loads all policy rules from the storage with context.

func (*FilteredAdapter) SavePolicy 

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

SavePolicy saves all policy rules to the storage.

func (*FilteredAdapter) SavePolicyCtx added in v2.128.0 

func (a *FilteredAdapter) SavePolicyCtx(ctx context.Context, model model.Model) error

SavePolicyCtx saves all policy rules to the storage with context.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.