specs

Documentation

Index

• Variables
• type Collection
  • func (c Collection) Disable()
  • func (c Collection) Enable()
  • func (c Collection) IsEnabled() bool
  • func (c Collection) IsMature() bool
  • func (c Collection) Name() string
• type Leaf
  • func (s Leaf) Disable()
  • func (s Leaf) Enable()
  • func (l Leaf) IsEnabled() bool
  • func (l Leaf) IsMature() bool
  • func (l Leaf) Name() string
• type Spec
  • func All() []Spec
  • func FromString(name string) (Spec, error)

Variables

var (
	TrustlessGatewayRaw         = Leaf{"trustless-block-gateway", stable}
	TrustlessGatewayCAR         = Leaf{"trustless-car-gateway", stable}
	TrustlessGatewayCAROptional = Leaf{"trustless-car-gateway-optional", stable}
	TrustlessGatewayIPNS        = Leaf{"trustless-ipns-gateway", stable}
	TrustlessGateway            = Collection{"trustless-gateway", []Spec{TrustlessGatewayRaw, TrustlessGatewayCAR, TrustlessGatewayCAROptional, TrustlessGatewayIPNS}}
	PathGatewayUnixFS           = Leaf{"path-unixfs-gateway", stable}
	PathGatewayIPNS             = Leaf{"path-ipns-gateway", stable}
	PathGatewayTAR              = Leaf{"path-tar-gateway", stable}
	PathGatewayDAG              = Leaf{"path-dag-gateway", stable}
	PathGatewayRaw              = Leaf{"path-raw-gateway", stable}
	PathGateway                 = Collection{"path-gateway", []Spec{PathGatewayUnixFS, PathGatewayIPNS, PathGatewayTAR, PathGatewayDAG, PathGatewayRaw}}
	SubdomainGatewayIPFS        = Leaf{"subdomain-ipfs-gateway", stable}
	SubdomainGatewayIPNS        = Leaf{"subdomain-ipns-gateway", stable}
	SubdomainGateway            = Collection{"subdomain-gateway", []Spec{SubdomainGatewayIPFS, SubdomainGatewayIPNS}}
	DNSLinkGateway              = Leaf{"dnslink-gateway", stable}
	RedirectsFile               = Leaf{"redirects-file", stable}
	ProxyGateway                = Leaf{"proxy-gateway", stable}
)

Types

type Collection

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

func (Collection) Disable

func (c Collection) Disable()

func (Collection) Enable

func (c Collection) Enable()

func (Collection) IsEnabled

func (c Collection) IsEnabled() bool

func (Collection) IsMature

func (c Collection) IsMature() bool

func (Collection) Name

func (c Collection) Name() string

type Leaf

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

func (Leaf) Disable

func (s Leaf) Disable()

func (Leaf) Enable

func (s Leaf) Enable()

func (Leaf) IsEnabled

func (l Leaf) IsEnabled() bool

func (Leaf) IsMature

func (l Leaf) IsMature() bool

IsMature returns maturity status (only reliable, stable, or permanent specs will return true). See https://specs.ipfs.tech/meta/spec-for-specs/

func (Leaf) Name

func (l Leaf) Name() string

type Spec

type Spec interface {
	Name() string
	IsEnabled() bool
	IsMature() bool
	Enable()
	Disable()
}

func All

func All() []Spec

func FromString

func FromString(name string) (Spec, error)