parser

Documentation

Index

• Constants
• func FormatBlock(block *ManagedBlock) string
• func FormatEntry(entry *HostEntry) string
• func ValidDomain(s string) bool
• func ValidIP(s string) bool
• type DisableType
• type HostEntry
  • func ParseLine(line string) (*HostEntry, error)
• type ManagedBlock
  • func ParseBlock(content string) *ManagedBlock

Constants

const (
	BlockStart = "#### hostfile >>>>>"
	BlockEnd   = "#### hostfile <<<<<"

	DisableIPPrefix     = "#[disable-ip]"
	DisableDomainPrefix = "#[disable-domain]"
)

Functions

func FormatBlock

func FormatBlock(block *ManagedBlock) string

FormatBlock formats a ManagedBlock back to string including the marker lines.

func FormatEntry

func FormatEntry(entry *HostEntry) string

FormatEntry formats a single HostEntry back to a hosts file line.

func ValidDomain

func ValidDomain(s string) bool

ValidDomain checks if a string is a valid domain name for hosts file use.

func ValidIP

func ValidIP(s string) bool

ValidIP checks if a string is a valid IP address, including IPv6 with zone ID (e.g. fe80::1%lo0).

Types

type DisableType

type DisableType int

const (
	DisableNone   DisableType = iota
	DisableIP                 // entire line disabled
	DisableDomain             // single domain disabled
)

type HostEntry

type HostEntry struct {
	IP          string
	Domains     []string
	DisableType DisableType
}

HostEntry represents a single entry in the managed block. For normal and disable-ip entries: IP + Domains. For disable-domain entries: IP + Domains (single domain that was disabled).

func ParseLine

func ParseLine(line string) (*HostEntry, error)

ParseLine parses a single line from within the managed block. Returns nil entry and nil error for empty/comment lines that should be skipped.

type ManagedBlock

type ManagedBlock struct {
	Entries  []HostEntry
	Warnings []string
}

ManagedBlock holds all entries within the managed block, plus any lines that failed to parse (stored as warnings).

func ParseBlock

func ParseBlock(content string) *ManagedBlock

ParseBlock parses the content inside a managed block (without the marker lines).