relationships

Documentation

Index

• func NewInvalidSubjectTypeError(relationship tuple.Relationship, relationType *core.AllowedRelation, ...) error
• func ValidateOneRelationship(namespaceMap map[string]*typesystem.TypeSystem, ...) error
• func ValidateRelationshipUpdates(ctx context.Context, reader datastore.Reader, ...) error
• func ValidateRelationshipsForCreateOrTouch(ctx context.Context, reader datastore.Reader, rels ...tuple.Relationship) error
• type CannotWriteToPermissionError
  • func NewCannotWriteToPermissionError(rel tuple.Relationship) CannotWriteToPermissionError
  • func (err CannotWriteToPermissionError) GRPCStatus() *status.Status
• type CaveatNotFoundError
  • func NewCaveatNotFoundError(relationship tuple.Relationship) CaveatNotFoundError
  • func (err CaveatNotFoundError) GRPCStatus() *status.Status
• type InvalidSubjectTypeError
  • func (err InvalidSubjectTypeError) GRPCStatus() *status.Status
• type ValidationRelationshipRule

Functions

func NewInvalidSubjectTypeError

func NewInvalidSubjectTypeError(
	relationship tuple.Relationship,
	relationType *core.AllowedRelation,
	typeSystem *typesystem.TypeSystem,
) error

NewInvalidSubjectTypeError constructs a new error for attempting to write an invalid subject type.

func ValidateOneRelationship

func ValidateOneRelationship(
	namespaceMap map[string]*typesystem.TypeSystem,
	caveatMap map[string]*core.CaveatDefinition,
	rel tuple.Relationship,
	rule ValidationRelationshipRule,
) error

ValidateOneRelationship validates a single relationship for CREATE/TOUCH or DELETE.

func ValidateRelationshipUpdates

func ValidateRelationshipUpdates(
	ctx context.Context,
	reader datastore.Reader,
	updates []tuple.RelationshipUpdate,
) error

ValidateRelationshipUpdates performs validation on the given relationship updates, ensuring that they can be applied against the datastore.

func ValidateRelationshipsForCreateOrTouch

func ValidateRelationshipsForCreateOrTouch(
	ctx context.Context,
	reader datastore.Reader,
	rels ...tuple.Relationship,
) error

ValidateRelationshipsForCreateOrTouch performs validation on the given relationships to be written, ensuring that they can be applied against the datastore.

NOTE: This method *cannot* be used for relationships that will be deleted.

Types

type CannotWriteToPermissionError

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

CannotWriteToPermissionError indicates that a write was attempted on a permission.

func NewCannotWriteToPermissionError

func NewCannotWriteToPermissionError(rel tuple.Relationship) CannotWriteToPermissionError

NewCannotWriteToPermissionError constructs a new error for attempting to write to a permission.

func (CannotWriteToPermissionError) GRPCStatus

func (err CannotWriteToPermissionError) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

type CaveatNotFoundError

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

CaveatNotFoundError indicates that a caveat referenced in a relationship update was not found.

func NewCaveatNotFoundError

func NewCaveatNotFoundError(relationship tuple.Relationship) CaveatNotFoundError

NewCaveatNotFoundError constructs a new caveat not found error.

func (CaveatNotFoundError) GRPCStatus

func (err CaveatNotFoundError) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

type InvalidSubjectTypeError

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

InvalidSubjectTypeError indicates that a write was attempted with a subject type which is not allowed on relation.

func (InvalidSubjectTypeError) GRPCStatus

func (err InvalidSubjectTypeError) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

type ValidationRelationshipRule

type ValidationRelationshipRule int

ValidationRelationshipRule is the rule to use for the validation.

const (
	// ValidateRelationshipForCreateOrTouch indicates that the validation should occur for a CREATE or TOUCH operation.
	ValidateRelationshipForCreateOrTouch ValidationRelationshipRule = 0

	// ValidateRelationshipForDeletion indicates that the validation should occur for a DELETE operation.
	ValidateRelationshipForDeletion ValidationRelationshipRule = 1
)