parsers

README

parsers

This directory contains pre-built, custom parsers that can be used with env.ParseWithFuncs to facilitate the parsing of envs that are not basic types.

Example Usage:

package main

import (
	"fmt"
	"log"
	"net/url"

	"github.com/caarlos0/env"
	"github.com/caarlos0/env/parsers"
)

type config struct {
	ExampleURL url.URL `env:"EXAMPLE_URL" envDefault:"https://google.com"`
}

func main() {
	cfg := config{}

	if err := env.ParseWithFuncs(&cfg, env.CustomParsers{
		parsers.URLType: parsers.URLFunc,
	}); err != nil {
		log.Fatal("Unable to parse envs: ", err)
	}

	fmt.Printf("Scheme: %v Host: %v\n", cfg.ExampleURL.Scheme, cfg.ExampleURL.Host)
}

Documentation

Overview

Package parsers contains custom parser funcs for common, non-built-in types

Index

• Variables
• func URLFunc(v string) (interface{}, error)

Variables

var (
	// URLType is a helper var that represents the `reflect.Type“ of `url.URL`
	URLType = reflect.TypeOf(url.URL{})
)

Functions

func URLFunc

func URLFunc(v string) (interface{}, error)

URLFunc is a basic parser for the url.URL type that should be used with `env.ParseWithFuncs()`