ref

Documentation

Index

• func IsKnownField(field string) bool
• func NormalizeFields(fields []string) ([]string, error)
• func WireFieldName(field string) string
• type PinFetch
  • func DedupAndUnion(fetches []PinFetch) []PinFetch
  • func ParsePinFetch(arg string, defaultFields []string) (PinFetch, error)
• type PinRef
  • func ParsePin(arg string) (PinRef, error)
• type SessionRef
  • func ParseSession(arg string) (SessionRef, error)

Functions

func IsKnownField

func IsKnownField(field string) bool

IsKnownField reports whether field is part of the user-facing field vocabulary.

func NormalizeFields

func NormalizeFields(fields []string) ([]string, error)

NormalizeFields validates fields, removes duplicates, and returns canonical order.

func WireFieldName

func WireFieldName(field string) string

WireFieldName returns the API wire field name for a validated user-facing field.

Types

type PinFetch

type PinFetch struct {
	Pin    PinRef
	Fields []string
}

PinFetch identifies a pin and the fields to fetch for it.

func DedupAndUnion

func DedupAndUnion(fetches []PinFetch) []PinFetch

DedupAndUnion merges fetches for the same pin while preserving first-seen pin order.

func ParsePinFetch

func ParsePinFetch(arg string, defaultFields []string) (PinFetch, error)

ParsePinFetch parses a pin reference with an optional colon-delimited field override.

type PinRef

type PinRef struct {
	Session int64
	Pin     int64
}

PinRef identifies a pin within a Disbug session.

func ParsePin

func ParsePin(arg string) (PinRef, error)

ParsePin parses a positive session and pin reference in session.pin form.

type SessionRef

type SessionRef struct {
	ID int64
}

SessionRef identifies a Disbug session.

func ParseSession

func ParseSession(arg string) (SessionRef, error)

ParseSession parses a positive integer session reference.