Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

formatter

package

Go to main page

Versions in this module

v3

v3.1.0

Oct 27, 2025

Changes in this version

type JSONOutputOptions

+ SnakeCase bool

v3.0.5

Apr 3, 2025

v3.0.4

Feb 8, 2025

v3.0.3

Feb 7, 2025

v3.0.2

Aug 18, 2024

v3.0.1

Jun 26, 2024

v3.0.0

Jun 2, 2024

Changes in this version

+ const DotClosedPortColor

+ const DotDefaultColor

+ const DotFilteredPortColor

+ const DotFontStyle

+ const DotLayout

+ const DotOpenPortColor

+ var DotDefaultOptions = map[string]string

+ var DotTemplate string

+ var ExcelColWidth float64 = 50

+ var HTMLSimpleTemplate string

+ var MarkdownTemplate string

+ var SqliteDDL string

+ func TemplateContent(f Formatter, c *Config) (string, error)

+ type CSVFormatter struct

+ func (f *CSVFormatter) Format(td *TemplateData, templateContent string) (err error)

+ type CSVOutputOptions struct

+ type CellData struct

+ type Config struct

+ CurrentVersion string

+ CustomOptions []string

+ FilterExpressions []string

+ InputFileConfig InputFileConfig

+ OutputFile OutputFile

+ OutputFormat OutputFormat

+ OutputOptions OutputOptions

+ ShowVersion bool

+ SkipDownHosts bool

+ TemplatePath string

+ Writer io.WriteCloser

+ func (c *Config) CustomOptionsMap() map[string]string

+ type D2LangFormatter struct

+ func (f *D2LangFormatter) Format(td *TemplateData, templateContent string) (err error)

+ type D2LangOutputOptions struct

+ type Debugging struct

+ Level int

+ type Distance struct

+ Value int

+ type DotFormatter struct

+ func (f *DotFormatter) Format(td *TemplateData, templateContent string) (err error)

+ type DotTemplateData struct

+ Constants map[string]string

+ NMAPRun *NMAPRun

+ type ExcelFormatter struct

+ func (f *ExcelFormatter) Format(td *TemplateData, templateContent string) (err error)

+ type ExcelOutputOptions struct

+ type ExtraPorts struct

+ Count int

+ State string

+ type Finished struct

+ Elapsed float64

+ Exit string

+ Summary string

+ Time int

+ TimeStr string

+ type Formatter interface

+ Format func(td *TemplateData, templateContent string) error

+ func New(config *Config) Formatter

+ type HTMLFormatter struct

+ func (f *HTMLFormatter) Format(td *TemplateData, templateContent string) error

+ type HTMLOutputOptions struct

+ DarkMode bool

+ FloatingContentsTable bool

+ SkipHeader bool

+ SkipMetrics bool

+ SkipPortScripts bool

+ SkipSummary bool

+ SkipTOC bool

+ SkipTraceroute bool

+ type Hop struct

+ Host string

+ IPAddr string

+ RTT RTT

+ TTL int

+ type Host struct

+ Distance Distance

+ EndTime int

+ HostAddress []HostAddress

+ HostNames HostNames

+ IPIDSequence IPIDSequence

+ OS OS

+ Port []Port

+ StartTime int

+ Status HostStatus

+ TCPSequence TCPSequence

+ TCPTSSequence TCPTSSequence

+ Trace Trace

+ Uptime Uptime

+ func (h *Host) JoinedAddresses(delimiter string) string

+ func (h *Host) JoinedHostNames(delimiter string) string

+ type HostAddress struct

+ Address string

+ AddressType string

+ Vendor string

+ type HostName struct

+ Name string

+ Type string

+ type HostNames struct

+ HostName []HostName

+ type HostRepository struct

+ type HostStatus struct

+ Reason string

+ State string

+ func (hs *HostStatus) IsUp() bool

+ type IPIDSequence struct

+ Class string

+ Values string

+ type InputFile string

+ type InputFileConfig struct

+ IsStdin bool

+ Path string

+ Source io.ReadCloser

+ func (i *InputFileConfig) ExistsOpen() error

+ type JSONFormatter struct

+ func (f *JSONFormatter) Format(td *TemplateData, templateContent string) (err error)

+ type JSONOutputOptions struct

+ PrettyPrint bool

+ type MainWorkflow struct

+ Config *Config

+ func (w *MainWorkflow) Execute() (err error)

+ func (w *MainWorkflow) SetConfig(c *Config)

+ func (w *MainWorkflow) SetInputFile()

+ func (w *MainWorkflow) SetOutputFile()

+ type MarkdownFormatter struct

+ func (f *MarkdownFormatter) Format(td *TemplateData, templateContent string) (err error)

+ type MarkdownOutputOptions struct

+ SkipHeader bool

+ SkipMetrics bool

+ SkipPortScripts bool

+ SkipSummary bool

+ SkipTOC bool

+ SkipTraceroute bool

+ type NMAPRun struct

+ Args string

+ Debugging Debugging

+ Host []Host

+ RunStats RunStats

+ ScanInfo ScanInfo

+ Scanner string

+ Start int

+ StartStr string

+ Verbose Verbose

+ Version string

+ func (n *NMAPRun) AllHops() map[string]Hop

+ type OS struct

+ OSClass []OSClass

+ OSMatch []OSMatch

+ OSPortUsed []OSPortUsed

+ type OSClass struct

+ Accuracy string

+ CPE []string

+ OSFamily string

+ OSGen string

+ Type string

+ Vendor string

+ type OSMatch struct

+ Accuracy string

+ Line string

+ Name string

+ type OSPortUsed struct

+ PortID int

+ Protocol string

+ State string

+ type OSRepository struct

+ type OutputFile string

+ type OutputFormat string

+ const CSVOutput

+ const D2LangOutput

+ const DotOutput

+ const ExcelOutput

+ const HTMLOutput

+ const JSONOutput

+ const MarkdownOutput

+ const SqliteOutput

+ func (of OutputFormat) IsValid() bool

+ type OutputOptions struct

+ CSVOptions CSVOutputOptions

+ D2LangOptions D2LangOutputOptions

+ ExcelOptions ExcelOutputOptions

+ HTMLOptions HTMLOutputOptions

+ JSONOptions JSONOutputOptions

+ MarkdownOptions MarkdownOutputOptions

+ SqliteOutputOptions SqliteOutputOptions

+ type Port struct

+ PortID int

+ Protocol string

+ Script []Script

+ Service PortService

+ State PortState

+ type PortRepository struct

+ type PortService struct

+ CPE []string

+ Conf string

+ ExtraInfo string

+ Method string

+ Name string

+ Product string

+ Version string

+ type PortState struct

+ Reason string

+ ReasonTTL string

+ State string

+ type RTT float64

+ func (r *RTT) UnmarshalXMLAttr(attr xml.Attr) error

+ type RunStats struct

+ Finished Finished

+ Hosts StatHosts

+ type ScanInfo struct

+ NumServices int

+ Protocol string

+ Services string

+ Type string

+ type ScanRepository struct

+ type Script struct

+ ID string

+ Output string

+ type SqliteDB struct

+ func NewSqliteDB(c *Config) (*SqliteDB, error)

+ type SqliteFormatter struct

+ func (f *SqliteFormatter) Format(td *TemplateData, templateContent string) error

+ type SqliteOutputOptions struct

+ DSN string

+ ScanIdentifier string

+ type StatHosts struct

+ Down int

+ Total int

+ Up int

+ type TCPSequence struct

+ Difficulty string

+ Index string

+ Values string

+ type TCPTSSequence struct

+ Class string

+ Values string

+ type TemplateData struct

+ CustomOptions map[string]string

+ NMAPRun NMAPRun

+ OutputOptions OutputOptions

+ type Trace struct

+ Hops []Hop

+ Port int

+ Protocol string

+ type Uptime struct

+ LastBoot string

+ Seconds int

+ type Verbose struct

+ Level int

+ type Workflow interface

+ Execute func() (err error)

+ SetConfig func(c *Config)

+ SetInputFile func()

+ SetOutputFile func()

Other modules containing this package

github.com/vdjagilev/nmap-formatter

github.com/vdjagilev/nmap-formatter/v2