assettypes

Documentation

Overview

Package assettypes defines a set of asset types that are valid in the context of Lava.

Index

• Constants
• Variables
• func CheckReachable(typ types.AssetType, ident string) error
• func IsValid(at types.AssetType) bool
• func ToVulcan(at types.AssetType) types.AssetType

Constants

const (
	Path = types.AssetType("Path")
)

Lava asset types.

Variables

var ErrUnsupported = errors.New("unsupported asset type")

ErrUnsupported is returned when the requested operation does not support the specified asset type.

Functions

func CheckReachable

func CheckReachable(typ types.AssetType, ident string) error

CheckReachable checks if the asset with the specified type and identifier is reachable. CheckReachable does not check if the asset is functional. If the asset is reachable, it returns a nil error. If the asset is unreachable, it returns an error explaining the cause. If the asset type is not supported, it returns an ErrUnsupported error. If the reachability test fails, it returns the error that caused the failure.

func IsValid

func IsValid(at types.AssetType) bool

IsValid reports whether the provided asset type is valid in the context of Lava.

func ToVulcan

func ToVulcan(at types.AssetType) types.AssetType

ToVulcan maps a Lava asset type to a Vulcan asset type. If there is no such mapping, the provided asset type is returned.