file

package

v0.2.10 Latest Latest Go to latest Published: Feb 6, 2024 License: MPL-2.0 Imports: 10 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/hashicorp/nodeenrollment

Links

Open Source Insights

Documentation ¶

Index ¶

type Option
- func WithBaseDirectory(with string) Option
- func WithSkipCleanup(with bool) Option
type Options
type Storage
- func New(ctx context.Context, opt ...Option) (*Storage, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(*Options) error

Option is a function that takes in an options struct and sets values or returns an error

func WithBaseDirectory ¶

func WithBaseDirectory(with string) Option

WithDirectory allows specifying a base directory to use

func WithSkipCleanup ¶

func WithSkipCleanup(with bool) Option

WithSkipCleanup causes FileStorage cleanup to be a no-op, useful for inspecting state after the fact

type Options ¶

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

type Storage ¶

type Storage struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func New ¶

func New(ctx context.Context, opt ...Option) (*Storage, error)

New creates a new object that implements the Storage interface in an on-disk directory. This is not currently explicitly thread-safe, although it may work without issue in that manner. Call Cleanup() when done with it.

Supported options: WithBaseDirectory, WithSkipCleanup

For safety, if a base directory is specified (that is, it's not a temporary directory generated by this function), cleanup is _always_ skipped.

func (*Storage) BaseDir ¶

func (ts *Storage) BaseDir() string

Returns the base directory being used, useful for displaying in tests for after-test inspection

func (*Storage) Cleanup ¶

func (ts *Storage) Cleanup(_ context.Context) error

Cleanup provides a function to clean up after tests

func (*Storage) List ¶

func (ts *Storage) List(ctx context.Context, msg proto.Message) ([]string, error)

List implements the Storage interface

func (*Storage) Load ¶

func (ts *Storage) Load(ctx context.Context, msg nodeenrollment.MessageWithId) error

Load implements the Storage interface

func (*Storage) Remove ¶

func (ts *Storage) Remove(ctx context.Context, msg nodeenrollment.MessageWithId) error

Remove implements the Storage interface

func (*Storage) Store ¶

func (ts *Storage) Store(ctx context.Context, msg nodeenrollment.MessageWithId) error

Store implements the Storage interface.

If the message already exists, it is overwritten.

Source Files ¶

View all Source files

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