gateway

Feb 20, 2024

Changes in this version

type BlocksBackend

+ func (bb *BlocksBackend) WrapContextForRequest(ctx context.Context) context.Context

+ type Headers struct

+ func NewHeaders(headers map[string][]string) *Headers

+ func (h *Headers) ApplyCors() *Headers

+ func (h *Headers) Wrap(next http.Handler) http.Handler

+ type WithContextHint interface

+ WrapContextForRequest func(context.Context) context.Context

Nov 1, 2023

Changes in this version

+ func InlineDNSLink(fqdn string) (dnsLabel string, err error)

+ func UninlineDNSLink(dnsLabel string) (fqdn string)

type BlocksBackendOption

+ func WithResolver(r resolver.Resolver) BlocksBackendOption

type ContentPathMetadata

+ LastSegmentRemainder []string

type GetResponse

+ func NewGetResponseFromReader(file io.ReadCloser, fullFileSize int64) *GetResponse

+ func NewGetResponseFromSymlink(symlink *files.Symlink, size int64) *GetResponse

+ func (r *GetResponse) Close() error

+ type HeadResponse struct

+ func NewHeadResponseForDirectory(dagSize int64) *HeadResponse

+ func NewHeadResponseForFile(startingBytes io.ReadCloser, size int64) *HeadResponse

+ func NewHeadResponseForSymlink(symlinkSize int64) *HeadResponse

+ func (r *HeadResponse) Close() error

Sep 21, 2023

Changes in this version

type Config

+ DisableHTMLErrors bool

Jul 26, 2023

Changes in this version

type CarParams

+ Duplicates DuplicateBlocksPolicy

+ Order DagOrder

+ type DagOrder string

+ const DagOrderDFS

+ const DagOrderUnknown

+ const DagOrderUnspecified

+ type DuplicateBlocksPolicy int

+ const DuplicateBlocksExcluded

+ const DuplicateBlocksIncluded

+ const DuplicateBlocksUnspecified

+ func NewDuplicateBlocksPolicy(dupsValue string) DuplicateBlocksPolicy

+ func (d DuplicateBlocksPolicy) Bool() bool

+ func (d DuplicateBlocksPolicy) String() string

Jun 9, 2023

Changes in this version

+ func NewHostnameHandler(c Config, backend IPFSBackend, next http.Handler) http.HandlerFunc

+ type BlocksBackend struct

+ func NewBlocksBackend(blockService blockservice.BlockService, opts ...BlocksBackendOption) (*BlocksBackend, error)

+ func (bb *BlocksBackend) Get(ctx context.Context, path ImmutablePath, ranges ...ByteRange) (ContentPathMetadata, *GetResponse, error)

+ func (bb *BlocksBackend) GetAll(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.Node, error)

+ func (bb *BlocksBackend) GetBlock(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.File, error)

+ func (bb *BlocksBackend) GetCAR(ctx context.Context, p ImmutablePath, params CarParams) (ContentPathMetadata, io.ReadCloser, error)

+ func (bb *BlocksBackend) GetDNSLinkRecord(ctx context.Context, hostname string) (ifacepath.Path, error)

+ func (bb *BlocksBackend) GetIPNSRecord(ctx context.Context, c cid.Cid) ([]byte, error)

+ func (bb *BlocksBackend) Head(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.Node, error)

+ func (bb *BlocksBackend) IsCached(ctx context.Context, p ifacepath.Path) bool

+ func (bb *BlocksBackend) ResolveMutable(ctx context.Context, p ifacepath.Path) (ImmutablePath, error)

+ func (bb *BlocksBackend) ResolvePath(ctx context.Context, path ImmutablePath) (ContentPathMetadata, error)

+ type BlocksBackendOption func(options *blocksBackendOptions) error

+ type CarParams struct

+ Range *DagByteRange

+ Scope DagScope

+ type DagByteRange struct

+ From int64

+ To *int64

+ func NewDagByteRange(rangeStr string) (DagByteRange, error)

+ type DagScope string

+ const DagScopeAll

+ const DagScopeBlock

+ const DagScopeEntity

type ErrorRetryAfter

+ func (e *ErrorRetryAfter) RetryAfterHeader() string

+ type ErrorStatusCode struct

+ Err error

+ StatusCode int

+ func NewErrorStatusCode(err error, statusCode int) *ErrorStatusCode

+ func NewErrorStatusCodeFromStatus(statusCode int) *ErrorStatusCode

+ func (e *ErrorStatusCode) Error() string

+ func (e *ErrorStatusCode) Is(err error) bool

+ func (e *ErrorStatusCode) Unwrap() error

+ type PublicGateway struct

+ DeserializedResponses bool

+ InlineDNSLink bool

+ NoDNSLink bool

+ Paths []string

+ UseSubdomains bool

Jun 8, 2023

Changes in this version

type Config

+ DeserializedResponses bool

+ Menu []assets.MenuItem

+ NoDNSLink bool

+ PublicGateways map[string]*Specification

type RequestContextKey

+ const SubdomainHostnameKey

type Specification

+ DeserializedResponses bool

Apr 5, 2023

Changes in this version

+ var ErrBadGateway = NewErrorResponseForCode(http.StatusBadGateway)

+ var ErrGatewayTimeout = NewErrorResponseForCode(http.StatusGatewayTimeout)

+ var ErrInternalServerError = NewErrorResponseForCode(http.StatusInternalServerError)

+ var ErrServiceUnavailable = NewErrorResponseForCode(http.StatusServiceUnavailable)

+ var ErrTooManyRequests = NewErrorResponseForCode(http.StatusTooManyRequests)

+ func AddAccessControlHeaders(headers map[string][]string)

+ func NewDNSResolver(resolvers map[string]string, dohOpts ...doh.Option) (*madns.Resolver, error)

+ func NewHandler(c Config, api IPFSBackend) http.Handler

+ func ServeContent(w http.ResponseWriter, req *http.Request, name string, modtime time.Time, ...) (int, bool, error)

+ func WithHostname(next http.Handler, api IPFSBackend, publicGateways map[string]*Specification, ...) http.HandlerFunc

+ type BlockGatewayOption func(gwOptions *gwOptions) error

+ func WithNameSystem(ns namesys.NameSystem) BlockGatewayOption

+ func WithValueStore(vs routing.ValueStore) BlockGatewayOption

+ type BlocksGateway struct

+ func NewBlocksGateway(blockService blockservice.BlockService, opts ...BlockGatewayOption) (*BlocksGateway, error)

+ func (api *BlocksGateway) Get(ctx context.Context, path ImmutablePath, ranges ...ByteRange) (ContentPathMetadata, *GetResponse, error)

+ func (api *BlocksGateway) GetAll(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.Node, error)

+ func (api *BlocksGateway) GetBlock(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.File, error)

+ func (api *BlocksGateway) GetCAR(ctx context.Context, path ImmutablePath) (ContentPathMetadata, io.ReadCloser, <-chan error, error)

+ func (api *BlocksGateway) GetDNSLinkRecord(ctx context.Context, hostname string) (ifacepath.Path, error)

+ func (api *BlocksGateway) GetIPNSRecord(ctx context.Context, c cid.Cid) ([]byte, error)

+ func (api *BlocksGateway) Head(ctx context.Context, path ImmutablePath) (ContentPathMetadata, files.Node, error)

+ func (api *BlocksGateway) IsCached(ctx context.Context, p ifacepath.Path) bool

+ func (api *BlocksGateway) ResolveMutable(ctx context.Context, p ifacepath.Path) (ImmutablePath, error)

+ func (api *BlocksGateway) ResolvePath(ctx context.Context, path ImmutablePath) (ContentPathMetadata, error)

+ type ByteRange struct

+ From uint64

+ To *int64

+ type Config struct

+ Headers map[string][]string

+ type ContentPathMetadata struct

+ ContentType string

+ LastSegment path.Resolved

+ PathSegmentRoots []cid.Cid

+ type ErrorResponse struct

+ Err error

+ StatusCode int

+ func NewErrorResponse(err error, statusCode int) *ErrorResponse

+ func NewErrorResponseForCode(statusCode int) *ErrorResponse

+ func (e *ErrorResponse) Error() string

+ func (e *ErrorResponse) Is(err error) bool

+ func (e *ErrorResponse) Unwrap() error

+ type ErrorRetryAfter struct

+ Err error

+ RetryAfter time.Duration

+ func NewErrorRetryAfter(err error, retryAfter time.Duration) *ErrorRetryAfter

+ func (e *ErrorRetryAfter) Error() string

+ func (e *ErrorRetryAfter) HTTPHeaderValue() string

+ func (e *ErrorRetryAfter) Humanized() string

+ func (e *ErrorRetryAfter) Is(err error) bool

+ func (e *ErrorRetryAfter) RoundSeconds() time.Duration

+ func (e *ErrorRetryAfter) Unwrap() error

+ type GetResponse struct

+ func NewGetResponseFromDirectoryListing(dagSize uint64, entries <-chan unixfs.LinkResult) *GetResponse

+ func NewGetResponseFromFile(file files.File) *GetResponse

+ type IPFSBackend interface

+ Get func(context.Context, ImmutablePath, ...ByteRange) (ContentPathMetadata, *GetResponse, error)

+ GetAll func(context.Context, ImmutablePath) (ContentPathMetadata, files.Node, error)

+ GetBlock func(context.Context, ImmutablePath) (ContentPathMetadata, files.File, error)

+ GetCAR func(context.Context, ImmutablePath) (ContentPathMetadata, io.ReadCloser, <-chan error, error)

+ GetDNSLinkRecord func(context.Context, string) (path.Path, error)

+ GetIPNSRecord func(context.Context, cid.Cid) ([]byte, error)

+ Head func(context.Context, ImmutablePath) (ContentPathMetadata, files.Node, error)

+ IsCached func(context.Context, path.Path) bool

+ ResolveMutable func(context.Context, path.Path) (ImmutablePath, error)

+ ResolvePath func(context.Context, ImmutablePath) (ContentPathMetadata, error)

+ type ImmutablePath struct

+ func NewImmutablePath(p path.Path) (ImmutablePath, error)

+ func (i ImmutablePath) IsValid() error

+ func (i ImmutablePath) Mutable() bool

+ func (i ImmutablePath) Namespace() string

+ func (i ImmutablePath) String() string

+ type RequestContextKey string

+ const ContentPathKey

+ const DNSLinkHostnameKey

+ const GatewayHostnameKey

+ type Specification struct

+ InlineDNSLink bool

+ NoDNSLink bool

+ Paths []string

+ UseSubdomains bool