options

Documentation

Overview

The options package includes some default option parsers for the requests package.

Index

• func Default(orig, value interface{}, optionValue string) (interface{}, error)
• func Immutable(orig, value interface{}, optionValue string) (interface{}, error)
• func Required(orig, value interface{}, optionValue string) (interface{}, error)

Functions

func Default

func Default(orig, value interface{}, optionValue string) (interface{}, error)

Default is an option func that sets a default value for a field. If the value doesn't exist in the request (or is nil), the provided default will be used instead.

func Immutable

func Immutable(orig, value interface{}, optionValue string) (interface{}, error)

Immutable is an option func that ensures that a value is not modified after being set. It will return an error if orig is non-empty and does not match the new value from the request.

func Required

func Required(orig, value interface{}, optionValue string) (interface{}, error)

Required is an option func that ensures a non-nil value was passed along in the request. It does not ensure that the value is non-empty.