devchar

Documentation

Index

• func NewCommand(logger logger.Interface) *cli.Command
• type Creator
  • func NewSymlinkCreator(opts ...Option) (Creator, error)
• type Option
  • func WithCreateAll(createAll bool) Option
  • func WithCreateDeviceNodes(createDeviceNodes bool) Option
  • func WithDevCharPath(path string) Option
  • func WithDevRoot(root string) Option
  • func WithDriverRoot(root string) Option
  • func WithDryRun(dryRun bool) Option
  • func WithLoadKernelModules(loadKernelModules bool) Option
  • func WithLogger(logger logger.Interface) Option

Functions

func NewCommand

func NewCommand(logger logger.Interface) *cli.Command

NewCommand constructs a command sub-command with the specified logger

Types

type Creator

type Creator interface {
	CreateLinks() error
}

Creator is an interface for creating symlinks to /dev/nv* devices in /dev/char.

func NewSymlinkCreator

func NewSymlinkCreator(opts ...Option) (Creator, error)

NewSymlinkCreator creates a new linkCreator.

type Option

type Option func(*linkCreator)

Option is a functional option for configuring the linkCreator.

func WithCreateAll

func WithCreateAll(createAll bool) Option

WithCreateAll sets the createAll flag for the linkCreator.

func WithCreateDeviceNodes

func WithCreateDeviceNodes(createDeviceNodes bool) Option

WithCreateDeviceNodes sets the createDeviceNodes flag for the linkCreator.

func WithDevCharPath

func WithDevCharPath(path string) Option

WithDevCharPath sets the path at which the symlinks will be created.

func WithDevRoot

func WithDevRoot(root string) Option

WithDevRoot sets the root path for the /dev directory.

func WithDriverRoot

func WithDriverRoot(root string) Option

WithDriverRoot sets the driver root path. This is the path in which kernel modules must be loaded.

func WithDryRun

func WithDryRun(dryRun bool) Option

WithDryRun sets the dry run flag.

func WithLoadKernelModules

func WithLoadKernelModules(loadKernelModules bool) Option

WithLoadKernelModules sets the loadKernelModules flag for the linkCreator.

func WithLogger

func WithLogger(logger logger.Interface) Option

WithLogger sets the logger.