evolution

Documentation

Overview

Package evolution tracks protocol evolution and deprecation.

Index

• func FormatFamily(f *ProtocolFamily) string
• type DeprecationWarning
• type ProtocolFamily
• type ProtocolVersion
• type Tracker
  • func NewTracker() *Tracker
  • func (t *Tracker) CheckDeprecation(protoName string) []DeprecationWarning
  • func (t *Tracker) GetFamily(name string) *ProtocolFamily

Functions

func FormatFamily

func FormatFamily(f *ProtocolFamily) string

FormatFamily formats a protocol family as a timeline.

Types

type DeprecationWarning

type DeprecationWarning struct {
	Protocol    string `json:"protocol"`
	Field       string `json:"field,omitempty"`
	Reason      string `json:"reason"`
	Alternative string `json:"alternative"`
	Severity    string `json:"severity"` // "info", "warning", "critical"
}

DeprecationWarning represents a deprecation warning.

type ProtocolFamily

type ProtocolFamily struct {
	Name     string            `json:"name"`
	Versions []ProtocolVersion `json:"versions"`
}

ProtocolFamily represents a family of related protocols.

type ProtocolVersion

type ProtocolVersion struct {
	Name       string   `json:"name"`
	Version    string   `json:"version"`
	RFC        string   `json:"rfc,omitempty"`
	Year       int      `json:"year,omitempty"`
	Status     string   `json:"status"` // "active", "deprecated", "obsolete"
	Features   []string `json:"features,omitempty"`
	ReplacedBy string   `json:"replaced_by,omitempty"`
}

ProtocolVersion represents a specific protocol version.

type Tracker

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

Tracker tracks protocol evolution.

func NewTracker

func NewTracker() *Tracker

NewTracker creates a new evolution tracker.

func (*Tracker) CheckDeprecation

func (t *Tracker) CheckDeprecation(protoName string) []DeprecationWarning

CheckDeprecation checks if a protocol is deprecated.

func (*Tracker) GetFamily

func (t *Tracker) GetFamily(name string) *ProtocolFamily

GetFamily returns a protocol family by name.