specs

package

v0.5.1 Latest Latest Go to latest Published: Apr 11, 2024 License: Apache-2.0, MIT, Apache-2.0, + 1 more Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ipfs/gateway-conformance

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Collection
type Leaf
type Spec
- func All() []Spec
- func FromString(name string) (Spec, error)

Constants ¶

This section is empty.

Variables ¶

View Source

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}
)

Functions ¶

This section is empty.

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)

Source Files ¶

View all Source files

specs.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL