engcontext

Documentation

Overview

Package engcontext defines the EngineContext type.

Index

• func WithEntityContext(ctx context.Context, c *EntityContext) context.Context
• type EntityContext
  • func EntityFromContext(ctx context.Context) EntityContext
  • func (c *EntityContext) Validate(ctx context.Context, q db.Querier, providerStore providers.ProviderStore) error
  • func (c *EntityContext) ValidateProject(ctx context.Context, q db.Querier) error
• type Project
• type Provider

Functions

func WithEntityContext

func WithEntityContext(ctx context.Context, c *EntityContext) context.Context

WithEntityContext stores an EntityContext in the current context.

Types

type EntityContext

type EntityContext struct {
	Project  Project
	Provider Provider
}

EntityContext is the context of an entity. This is relevant for getting the full information about an entity.

func EntityFromContext

func EntityFromContext(ctx context.Context) EntityContext

EntityFromContext extracts the current EntityContext, WHICH MAY BE NIL!

func (*EntityContext) Validate

func (c *EntityContext) Validate(ctx context.Context, q db.Querier, providerStore providers.ProviderStore) error

Validate validates that the entity context contains values that are present in the DB

func (*EntityContext) ValidateProject

func (c *EntityContext) ValidateProject(ctx context.Context, q db.Querier) error

ValidateProject validates that the entity context contains a project that is present in the DB

type Project

type Project struct {
	ID uuid.UUID
}

Project is a construct relevant to an entity's context. This is relevant for getting the full information about an entity.

type Provider

type Provider struct {
	Name string
}

Provider is a construct relevant to an entity's context. This is relevant for getting the full information about an entity.