flash

Documentation

Overview

Package flash implements flash messages.

Index

• type Flash
  • func New(values map[interface{}]interface{}) *Flash
  • func (f *Flash) Alert(msg string, vars ...interface{})
  • func (f *Flash) Alerts() []string
  • func (f *Flash) Clear()
  • func (f *Flash) Clone(values map[interface{}]interface{})
  • func (f *Flash) Error(msg string, vars ...interface{})
  • func (f *Flash) Errors() []string
  • func (f *Flash) Warning(msg string, vars ...interface{})
  • func (f *Flash) Warnings() []string

Types

type Flash

type Flash struct {
	// contains filtered or unexported fields
}

Flash is a collection of data that is discarded on read. It's designed to be compatible with sessions.Values.

func New

func New(values map[interface{}]interface{}) *Flash

New creates a new flash handler.

func (*Flash) Alert

func (f *Flash) Alert(msg string, vars ...interface{})

Alert adds a new alert to the upcoming flash instance.

func (*Flash) Alerts

func (f *Flash) Alerts() []string

Alerts returns the list of alerts in flash, if any.

func (*Flash) Clear

func (f *Flash) Clear()

Clear removes all items from the flash. It's rare to call Clear since flashes are cleared automatically upon reading.

func (*Flash) Clone

func (f *Flash) Clone(values map[interface{}]interface{})

Clone makes a copy of this flash data into the new target.

func (*Flash) Error

func (f *Flash) Error(msg string, vars ...interface{})

Error adds a new error to the upcoming flash instance.

func (*Flash) Errors

func (f *Flash) Errors() []string

Errors returns the list of errors in flash, if any.

func (*Flash) Warning

func (f *Flash) Warning(msg string, vars ...interface{})

Warning adds a new alert to the upcoming flash instance.

func (*Flash) Warnings

func (f *Flash) Warnings() []string

Warnings returns the list of warnings in flash, if any.