pretty

Documentation

Index

• Variables
• type ContainerConf
  • func (conf ContainerConf) ContainerWrite(c *types.Container, out io.Writer) error
• type JourneyConf
  • func (conf JourneyConf) PrettyWrite(j *types.Journey, out io.Writer) error
• type JourneyResultsConf
  • func (conf JourneyResultsConf) PrettyWrite(jr *navitia.JourneyResults, out io.Writer) error
• type PlacesResultsConf
  • func (conf PlacesResultsConf) PrettyWrite(pr *navitia.PlacesResults, out io.Writer) error
• type SectionConf
  • func (conf SectionConf) PrettyWrite(s *types.Section, out io.Writer) error

Variables

var DefaultContainerConf = ContainerConf{
	Quality: color.New(color.FgMagenta),
	Type:    color.New(color.FgGreen),
	Name:    color.New(color.FgBlue),
}

DefaultContainerConf holds a default, quite good configuration

var DefaultJourneyConf = JourneyConf{
	Departure:      color.New(color.FgRed),
	Arrival:        color.New(color.FgRed),
	Duration:       color.New(color.FgMagenta),
	DateTimeLayout: timeLayout,
	Section:        DefaultSectionConf,
}

DefaultJourneyConf holds a default, quite good configuration

var DefaultJourneyResultsConf = JourneyResultsConf{
	Count:   color.New(color.FgBlack),
	Journey: DefaultJourneyConf,
}

DefaultJourneyResultsConf holds a default, quite good configuration

var DefaultPlacesResultsConf = PlacesResultsConf{
	Count: color.New(color.Italic),
	Place: DefaultContainerConf,
}

DefaultPlacesResultsConf holds a default, quite good configuration

var DefaultSectionConf = SectionConf{
	Mode:     color.New(color.FgGreen),
	Duration: color.New(color.FgMagenta),
	From:     color.New(color.FgBlue),
	To:       color.New(color.FgBlue),
}

DefaultSectionConf holds a default, quite good configuration

Types

type ContainerConf

type ContainerConf struct {
	Quality *color.Color
	Type    *color.Color
	Name    *color.Color
}

ContainerConf stores configuration for use in ContainerWrite

func (ContainerConf) ContainerWrite

func (conf ContainerConf) ContainerWrite(c *types.Container, out io.Writer) error

ContainerWrite writes a pretty-printed account of a types.Container to out.

type JourneyConf

type JourneyConf struct {
	Departure      *color.Color
	Arrival        *color.Color
	Duration       *color.Color
	DateTimeLayout string

	Section SectionConf
}

JourneyConf stores configuration for pretty-printing a types.Journey

func (JourneyConf) PrettyWrite

func (conf JourneyConf) PrettyWrite(j *types.Journey, out io.Writer) error

PrettyWrite writes a pretty-printed types.Journey to out

type JourneyResultsConf

type JourneyResultsConf struct {
	Count   *color.Color
	Journey JourneyConf
}

JourneyResultsConf stores configuration for pretty-printing a navitia.JourneyResults

func (JourneyResultsConf) PrettyWrite

func (conf JourneyResultsConf) PrettyWrite(jr *navitia.JourneyResults, out io.Writer) error

PrettyWrite writes a pretty-printed navitia.JourneyResults to out

type PlacesResultsConf

type PlacesResultsConf struct {
	Count *color.Color
	Place ContainerConf
}

PlacesResultsConf stores configuration for pretty-printing

func (PlacesResultsConf) PrettyWrite

func (conf PlacesResultsConf) PrettyWrite(pr *navitia.PlacesResults, out io.Writer) error

PrettyWrite writes a pretty-printed account of a navitia.PlacesResults to out.

type SectionConf

type SectionConf struct {
	Mode     *color.Color
	Duration *color.Color
	From     *color.Color
	To       *color.Color
	Emoji    bool
}

SectionConf stores configuration for pretty-printing a types.Section

func (SectionConf) PrettyWrite

func (conf SectionConf) PrettyWrite(s *types.Section, out io.Writer) error

PrettyWrite writes a pretty-printed types.Section to out