types

Documentation

Overview

Package types implements the types and validation of types necessary for the application to function.

Index

• func GetFields(reference interface{}) ([]string, error)
• func GetFieldsOrdered(reference interface{}) ([]string, error)
• func ValidateFields(document bson.D, reference interface{}) (bson.D, error)
• type Assemblies
  • func (a *Assemblies) TabbyPrint() error
• type AssembliesWithID
  • func (a *AssembliesWithID) TabbyPrint() error
• type Assembly
  • func (a *Assembly) TabbyPrint() error
• type AssemblyWithID
  • func (a *AssemblyWithID) TabbyPrint() error
• type Component
  • func (c *Component) TabbyPrint() error
• type ComponentWithID
  • func (c *ComponentWithID) TabbyPrint() error
• type Components
  • func (c *Components) TabbyPrint() error
• type ComponentsWithID
  • func (c *ComponentsWithID) TabbyPrint() error
• type InsertResult
  • func (r InsertResult) TabbyPrint() error
• type Kit
  • func (k *Kit) TabbyPrint() error
• type KitWithID
  • func (k *KitWithID) TabbyPrint() error
• type Kits
  • func (k *Kits) TabbyPrint() error
• type KitsWithID
  • func (k *KitsWithID) TabbyPrint() error
• type TabbyPrinter

Functions

func GetFields

func GetFields(reference interface{}) ([]string, error)

GetFields returns an unordered list of fields in a reference interface{}

func GetFieldsOrdered

func GetFieldsOrdered(reference interface{}) ([]string, error)

func ValidateFields

func ValidateFields(document bson.D, reference interface{}) (bson.D, error)

Taking a bson.D and a reference interface{}, returns a bson.D that only contains fields whose keys are also valid keys in the reference interface{}.

If an error is encountered, it is returned, and the returned bson.D will be nil.

If no error is encountered, the validated bson.D is returned, and the error will be nil.

Types

type Assemblies

type Assemblies struct {
	Assemblies []Assembly `json:"assemblies"`
}

func (*Assemblies) TabbyPrint

func (a *Assemblies) TabbyPrint() error

type AssembliesWithID

type AssembliesWithID struct {
	AssembliesWithID []AssemblyWithID `json:"assemblies"`
}

func (*AssembliesWithID) TabbyPrint

func (a *AssembliesWithID) TabbyPrint() error

type Assembly

type Assembly struct {
	Name   string   `json:"name"`
	Tags   []string `json:"tags"`
	Status string   `json:"status"`

	// An assembly's Target should point to a kit's ObjectID
	Target primitive.ObjectID `json:"target"`
}

func (*Assembly) TabbyPrint

func (a *Assembly) TabbyPrint() error

type AssemblyWithID

type AssemblyWithID struct {
	ID primitive.ObjectID `json:"_id"`
	Assembly
}

func (*AssemblyWithID) TabbyPrint

func (a *AssemblyWithID) TabbyPrint() error

type Component

type Component struct {
	Name   string   `json:"name"`
	Tags   []string `json:"tags"`
	Status string   `json:"status"`

	// A component's Target should point to a kit's or assembly's ObjectID
	Target primitive.ObjectID `json:"target"`
}

func (*Component) TabbyPrint

func (c *Component) TabbyPrint() error

type ComponentWithID

type ComponentWithID struct {
	ID primitive.ObjectID `json:"_id"`
	Component
}

func (*ComponentWithID) TabbyPrint

func (c *ComponentWithID) TabbyPrint() error

type Components

type Components struct {
	Components []Component `json:"components"`
}

func (*Components) TabbyPrint

func (c *Components) TabbyPrint() error

type ComponentsWithID

type ComponentsWithID struct {
	ComponentsWithID []ComponentWithID `json:"components"`
}

func (*ComponentsWithID) TabbyPrint

func (c *ComponentsWithID) TabbyPrint() error

type InsertResult

type InsertResult struct {
	Message     string        `json:"message"`
	InsertedIDs []interface{} `json:"inserted_ids,omitempty"`
}

func (InsertResult) TabbyPrint

func (r InsertResult) TabbyPrint() error

type Kit

type Kit struct {
	Name   string   `json:"name"`
	Tags   []string `json:"tags"`
	Status string   `json:"status"`
}

func (*Kit) TabbyPrint

func (k *Kit) TabbyPrint() error

type KitWithID

type KitWithID struct {
	ID primitive.ObjectID `json:"_id"`
	Kit
}

func (*KitWithID) TabbyPrint

func (k *KitWithID) TabbyPrint() error

type Kits

type Kits struct {
	Kits []Kit `json:"kits"`
}

func (*Kits) TabbyPrint

func (k *Kits) TabbyPrint() error

type KitsWithID

type KitsWithID struct {
	KitsWithID []KitWithID `json:"kits"`
}

func (*KitsWithID) TabbyPrint

func (k *KitsWithID) TabbyPrint() error

type TabbyPrinter

type TabbyPrinter interface {
	TabbyPrint() error
}