resourceset

Documentation

Overview

package resourceset is a set of resources that provides a way to map permissions to fields in a struct.

Index

• type FieldMapper
  • func NewFieldMapper(v any) (*FieldMapper, error)
  • func (f *FieldMapper) Fields() []accesstypes.Field
  • func (f *FieldMapper) Len() int
  • func (f *FieldMapper) StructFieldName(tag string) (accesstypes.Field, bool)
• type ResourceSet
  • func New(v any, resource accesstypes.Resource, permissions ...accesstypes.Permission) (*ResourceSet, error)
  • func (r *ResourceSet) BaseResource() accesstypes.Resource
  • func (r *ResourceSet) ImmutableFields() map[accesstypes.Tag]struct{}
  • func (r *ResourceSet) Permission() accesstypes.Permission
  • func (r *ResourceSet) PermissionRequired(fieldName accesstypes.Field, perm accesstypes.Permission) bool
  • func (r *ResourceSet) Permissions() []accesstypes.Permission
  • func (r *ResourceSet) Resource(fieldName accesstypes.Field) accesstypes.Resource
  • func (r *ResourceSet) TagPermissions() accesstypes.TagPermissions

Types

type FieldMapper

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

func NewFieldMapper

func NewFieldMapper(v any) (*FieldMapper, error)

func (*FieldMapper) Fields

func (f *FieldMapper) Fields() []accesstypes.Field

func (*FieldMapper) Len

func (f *FieldMapper) Len() int

func (*FieldMapper) StructFieldName

func (f *FieldMapper) StructFieldName(tag string) (accesstypes.Field, bool)

type ResourceSet

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

func New

func New(v any, resource accesstypes.Resource, permissions ...accesstypes.Permission) (*ResourceSet, error)

func (*ResourceSet) BaseResource

func (r *ResourceSet) BaseResource() accesstypes.Resource

func (*ResourceSet) ImmutableFields

func (r *ResourceSet) ImmutableFields() map[accesstypes.Tag]struct{}

func (*ResourceSet) Permission

func (r *ResourceSet) Permission() accesstypes.Permission

func (*ResourceSet) PermissionRequired

func (r *ResourceSet) PermissionRequired(fieldName accesstypes.Field, perm accesstypes.Permission) bool

func (*ResourceSet) Permissions

func (r *ResourceSet) Permissions() []accesstypes.Permission

func (*ResourceSet) Resource

func (r *ResourceSet) Resource(fieldName accesstypes.Field) accesstypes.Resource

func (*ResourceSet) TagPermissions

func (r *ResourceSet) TagPermissions() accesstypes.TagPermissions