graph

Documentation

Index

• Constants
• func AlwaysFail(ctx context.Context, resultChan chan<- CheckResult)
• func AlwaysFailExpand(ctx context.Context, resultChan chan<- ExpandResult)
• func NewAlwaysFailErr() error
• func NewCheckFailureErr(baseErr error) error
• func NewExpansionFailureErr(baseErr error) error
• func NewRelationMissingTypeInfoErr(nsName string, relationName string) error
• func NewRelationNotFoundErr(nsName string, relationName string) error
• func NewRequestCanceledErr() error
• type CheckResult
• type ConcurrentChecker
  • func NewConcurrentChecker(d dispatch.Check, ds datastore.GraphDatastore, nsm namespace.Manager) *ConcurrentChecker
  • func (cc *ConcurrentChecker) Check(ctx context.Context, req *v1.DispatchCheckRequest, relation *v0.Relation) (*v1.DispatchCheckResponse, error)
• type ConcurrentExpander
  • func NewConcurrentExpander(d dispatch.Expand, ds datastore.GraphDatastore, nsm namespace.Manager) *ConcurrentExpander
  • func (ce *ConcurrentExpander) Expand(ctx context.Context, req *v1.DispatchExpandRequest, relation *v0.Relation) (*v1.DispatchExpandResponse, error)
• type ConcurrentLookup
  • func NewConcurrentLookup(d dispatch.Lookup, ds datastore.GraphDatastore, nsm namespace.Manager) *ConcurrentLookup
  • func (cl *ConcurrentLookup) Lookup(ctx context.Context, req *v1.DispatchLookupRequest) (*v1.DispatchLookupResponse, error)
• type ErrAlwaysFail
• type ErrCheckFailure
• type ErrExpansionFailure
• type ErrRelationMissingTypeInfo
  • func (erf ErrRelationMissingTypeInfo) MarshalZerologObject(e *zerolog.Event)
  • func (erf ErrRelationMissingTypeInfo) NamespaceName() string
  • func (erf ErrRelationMissingTypeInfo) RelationName() string
• type ErrRelationNotFound
  • func (erf ErrRelationNotFound) MarshalZerologObject(e *zerolog.Event)
  • func (erf ErrRelationNotFound) NamespaceName() string
  • func (erf ErrRelationNotFound) NotFoundRelationName() string
• type ErrRequestCanceled
• type ExpandReducer
• type ExpandResult
• type LookupReducer
• type LookupResult
• type ReduceableCheckFunc
• type ReduceableExpandFunc
• type ReduceableLookupFunc
• type Reducer

Constants

const Ellipsis = "..."

Ellipsis relation is used to signify a semantic-free relationship.

Functions

func AlwaysFail

func AlwaysFail(ctx context.Context, resultChan chan<- CheckResult)

AlwaysFail is a ReduceableCheckFunc which will always fail when reduced.

func AlwaysFailExpand

func AlwaysFailExpand(ctx context.Context, resultChan chan<- ExpandResult)

AlwaysFailExpand is a ReduceableExpandFunc which will always fail when reduced.

func NewAlwaysFailErr

func NewAlwaysFailErr() error

NewAlwaysFailErr constructs a new always fail error.

func NewCheckFailureErr

func NewCheckFailureErr(baseErr error) error

NewCheckFailureErr constructs a new check failed error.

func NewExpansionFailureErr

func NewExpansionFailureErr(baseErr error) error

NewExpansionFailureErr constructs a new expansion failed error.

func NewRelationMissingTypeInfoErr

func NewRelationMissingTypeInfoErr(nsName string, relationName string) error

NewRelationMissingTypeInfoErr constructs a new relation not missing type information error.

func NewRelationNotFoundErr

func NewRelationNotFoundErr(nsName string, relationName string) error

NewRelationNotFoundErr constructs a new relation not found error.

func NewRequestCanceledErr

func NewRequestCanceledErr() error

NewRequestCanceledErr constructs a new request was canceled error.

Types

type CheckResult

type CheckResult struct {
	Resp *v1.DispatchCheckResponse
	Err  error
}

CheckResult is the data that is returned by a single check or sub-check.

type ConcurrentChecker

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

ConcurrentChecker exposes a method to perform Check requests, and delegates subproblems to the provided dispatch.Check instance.

func NewConcurrentChecker

func NewConcurrentChecker(d dispatch.Check, ds datastore.GraphDatastore, nsm namespace.Manager) *ConcurrentChecker

NewConcurrentChecker creates an instance of ConcurrentChecker.

func (*ConcurrentChecker) Check

func (cc *ConcurrentChecker) Check(ctx context.Context, req *v1.DispatchCheckRequest, relation *v0.Relation) (*v1.DispatchCheckResponse, error)

Check performs a check request with the provided request and context

type ConcurrentExpander

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

ConcurrentExpander exposes a method to perform Expand requests, and delegates subproblems to the provided dispatch.Expand instance.

func NewConcurrentExpander

func NewConcurrentExpander(d dispatch.Expand, ds datastore.GraphDatastore, nsm namespace.Manager) *ConcurrentExpander

NewConcurrentExpander creates an instance of ConcurrentExpander

func (*ConcurrentExpander) Expand

func (ce *ConcurrentExpander) Expand(ctx context.Context, req *v1.DispatchExpandRequest, relation *v0.Relation) (*v1.DispatchExpandResponse, error)

Expand performs an expand request with the provided request and context.

type ConcurrentLookup

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

ConcurrentLookup exposes a method to perform Lookup requests, and delegates subproblems to the provided dispatch.Lookup instance.

func NewConcurrentLookup

func NewConcurrentLookup(d dispatch.Lookup, ds datastore.GraphDatastore, nsm namespace.Manager) *ConcurrentLookup

NewConcurrentLookup creates and instance of ConcurrentLookup.

func (*ConcurrentLookup) Lookup

func (cl *ConcurrentLookup) Lookup(ctx context.Context, req *v1.DispatchLookupRequest) (*v1.DispatchLookupResponse, error)

Lookup performs a lookup request with the provided request and context.

type ErrAlwaysFail

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

ErrAlwaysFail is returned when an internal error leads to an operation guaranteed to fail.

type ErrCheckFailure

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

ErrCheckFailure occurs when check failed in some manner. Note this should not apply to namespaces and relations not being found.

type ErrExpansionFailure

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

ErrExpansionFailure occurs when expansion failed in some manner. Note this should not apply to namespaces and relations not being found.

type ErrRelationMissingTypeInfo

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

ErrRelationMissingTypeInfo defines an error for when type information is missing from a relation during a lookup.

func (ErrRelationMissingTypeInfo) MarshalZerologObject

func (erf ErrRelationMissingTypeInfo) MarshalZerologObject(e *zerolog.Event)

func (ErrRelationMissingTypeInfo) NamespaceName

func (erf ErrRelationMissingTypeInfo) NamespaceName() string

NamespaceName returns the name of the namespace in which the relation was found.

func (ErrRelationMissingTypeInfo) RelationName

func (erf ErrRelationMissingTypeInfo) RelationName() string

RelationName returns the name of the relation missing type information.

type ErrRelationNotFound

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

ErrRelationNotFound occurs when a relation was not found under a namespace.

func (ErrRelationNotFound) MarshalZerologObject

func (erf ErrRelationNotFound) MarshalZerologObject(e *zerolog.Event)

func (ErrRelationNotFound) NamespaceName

func (erf ErrRelationNotFound) NamespaceName() string

NamespaceName returns the name of the namespace in which the relation was not found.

func (ErrRelationNotFound) NotFoundRelationName

func (erf ErrRelationNotFound) NotFoundRelationName() string

NotFoundRelationName returns the name of the relation not found.

type ErrRequestCanceled

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

ErrRequestCanceled occurs when a request has been canceled.

type ExpandReducer

type ExpandReducer func(
	ctx context.Context,
	start *v0.ObjectAndRelation,
	requests []ReduceableExpandFunc,
) ExpandResult

ExpandReducer is a type for the functions Any and All which combine check results.

type ExpandResult

type ExpandResult struct {
	Resp *v1.DispatchExpandResponse
	Err  error
}

ExpandResult is the data that is returned by a single expand or sub-expand.

type LookupReducer

type LookupReducer func(ctx context.Context, limit uint32, requests []ReduceableLookupFunc) LookupResult

LookupReducer is a type for the functions which combine lookup results.

type LookupResult

type LookupResult struct {
	Resp *v1.DispatchLookupResponse
	Err  error
}

LookupResult is the data that is returned by a single lookup or sub-lookup.

type ReduceableCheckFunc

type ReduceableCheckFunc func(ctx context.Context, resultChan chan<- CheckResult)

ReduceableCheckFunc is a function that can be bound to a execution context.

type ReduceableExpandFunc

type ReduceableExpandFunc func(ctx context.Context, resultChan chan<- ExpandResult)

ReduceableExpandFunc is a function that can be bound to a execution context.

type ReduceableLookupFunc

type ReduceableLookupFunc func(ctx context.Context, resultChan chan<- LookupResult)

ReduceableLookupFunc is a function that can be bound to a execution context.

type Reducer

type Reducer func(ctx context.Context, requests []ReduceableCheckFunc) CheckResult

Reducer is a type for the functions Any and All which combine check results.