storage

Documentation

Overview

Package storage provide an URLOpener for certmagic.Storage interfaces

Index

• func OpenStore(ctx context.Context, urlstr string) (certmagic.Storage, error)
• type URLMux
  • func DefaultURLMux() *URLMux
  • func (mux *URLMux) OpenStore(ctx context.Context, urlstr string) (certmagic.Storage, error)
  • func (mux *URLMux) Register(scheme string, opener URLOpener)
  • func (mux *URLMux) Schemes() []string
  • func (mux *URLMux) ValidScheme(scheme string) bool
• type URLOpener

Functions

func OpenStore

func OpenStore(ctx context.Context, urlstr string) (certmagic.Storage, error)

OpenStore opens the Store identified by the URL given. See the URLOpener documentation in driver subpackages for details on supported URL formats, and https://gocloud.dev/concepts/urls for more information.

Types

type URLMux

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

URLMux is a URL opener multiplexer. It matches the scheme of the URLs against a set of registered schemes and calls the opener that matches the URL's scheme. See https://gocloud.dev/concepts/urls/ for more information.

The zero value is a multiplexer with no registered schemes.

func DefaultURLMux

func DefaultURLMux() *URLMux

DefaultURLMux returns the URLMux used by OpenTopic and OpenSubscription.

Driver packages can use this to register their TopicURLOpener and/or SubscriptionURLOpener on the mux.

func (*URLMux) OpenStore

func (mux *URLMux) OpenStore(ctx context.Context, urlstr string) (certmagic.Storage, error)

OpenStore calls OpenURL with the URL parsed from urlstr. OpenStore is safe to call from multiple goroutines.

func (*URLMux) Register

func (mux *URLMux) Register(scheme string, opener URLOpener)

Register registers the opener with the given scheme. If an opener already exists for the scheme, Register panics.

func (*URLMux) Schemes

func (mux *URLMux) Schemes() []string

Schemes returns a sorted slice of the registered schemes.

func (*URLMux) ValidScheme

func (mux *URLMux) ValidScheme(scheme string) bool

ValidScheme returns true if scheme has been registered.

type URLOpener

type URLOpener interface {
	OpenURL(ctx context.Context, u *url.URL) (certmagic.Storage, error)
}

URLOpener represents types than can open Registries based on a URL. The opener must not modify the URL argument. OpenURL must be safe to call from multiple goroutines.

This interface is generally implemented by types in driver packages.