file

Documentation

Overview

Package file implements decoding between configuration in a file and a typed Configuration.

Index

• func Decode(filePath string, element interface{}) error
• func DecodeContent(content, extension string, element interface{}) error

Functions

func Decode

func Decode(filePath string, element interface{}) error

Decode decodes the given configuration file into the given element. The operation goes through three stages roughly summarized as: file contents -> tree of untyped nodes untyped nodes -> nodes augmented with metadata such as kind (inferred from element) "typed" nodes -> typed element.

func DecodeContent

func DecodeContent(content, extension string, element interface{}) error

DecodeContent decodes the given configuration file content into the given element. The operation goes through three stages roughly summarized as: file contents -> tree of untyped nodes untyped nodes -> nodes augmented with metadata such as kind (inferred from element) "typed" nodes -> typed element.