yaml

Documentation

Overview

Package yaml provides methods to parse feature.Feature specifications also known as metadata, from YAML documents.

Index

• func ReadFeatures(md []byte) ([]feature.Feature, error)
• func ReadFeaturesFromFile(filepath string) ([]feature.Feature, error)

Functions

func ReadFeatures

func ReadFeatures(md []byte) ([]feature.Feature, error)

ReadFeatures takes a slice of bytes with a feature specification in YML and returns a slice of features parsed from it or an error. The YML is expected to be an object containing a features property. The value for this should be an object with a property for each feature with its name and either a string value of 'continuous' for continuous features or a list of valid values for discrete features.

func ReadFeaturesFromFile

func ReadFeaturesFromFile(filepath string) ([]feature.Feature, error)

ReadFeaturesFromFile takes a filepath string, reads its contents and uses ReadFeatures to parse it and return a slice of parsed features or an error. If the file indicated by the filepath cannot be opened for reading an error will be returned.