hostsfile

Documentation

Index

• Variables
• type Hosts
  • func NewCustomHosts(osHostsFilePath string) (Hosts, error)
  • func NewHosts() (Hosts, error)
  • func (h *Hosts) Add(ip string, hosts ...string) error
  • func (h *Hosts) Clean()
  • func (h Hosts) Flush() error
  • func (h Hosts) Has(ip string, host string) bool
  • func (h Hosts) HasHostname(host string) bool
  • func (h Hosts) HasIp(ip string) bool
  • func (h *Hosts) HostsPerLine(count int)
  • func (h *Hosts) IsWritable() bool
  • func (h *Hosts) Load() error
  • func (h *Hosts) Remove(ip string, hosts ...string) error
  • func (h *Hosts) RemoveByHostname(host string) error
  • func (h *Hosts) RemoveByIp(ip string) error
  • func (h *Hosts) RemoveDuplicateHosts()
  • func (h *Hosts) RemoveDuplicateIps()
  • func (h *Hosts) SortByIp()
  • func (h *Hosts) SortHosts()
• type HostsLine
  • func NewHostsLine(raw string) HostsLine
  • func (l *HostsLine) Combine(hostline HostsLine)
  • func (l *HostsLine) HasComment() bool
  • func (l *HostsLine) IsComment() bool
  • func (l *HostsLine) IsMalformed() bool
  • func (l *HostsLine) IsValid() bool
  • func (l *HostsLine) RegenRaw()
  • func (l *HostsLine) RemoveDuplicateHosts()
  • func (l *HostsLine) SortHosts()
  • func (l *HostsLine) ToRaw() string

Variables

var (
	HostsPerLine  = -1 // unlimited
	HostsFilePath = "/etc/hosts"
)

Types

type Hosts

type Hosts struct {
	Path  string
	Lines []HostsLine
}

func NewCustomHosts

func NewCustomHosts(osHostsFilePath string) (Hosts, error)

NewCustomHosts return a new instance of “Hosts“ using a custom hosts file path.

func NewHosts

func NewHosts() (Hosts, error)

NewHosts return a new instance of “Hosts“ using the default hosts file path.

func (*Hosts) Add

func (h *Hosts) Add(ip string, hosts ...string) error

Add an entry to the hosts file.

func (*Hosts) Clean

func (h *Hosts) Clean()

Clean merge duplicate ips and hosts per ip

func (Hosts) Flush

func (h Hosts) Flush() error

Flush any changes made to hosts file.

func (Hosts) Has

func (h Hosts) Has(ip string, host string) bool

Has return a bool if ip/host combo in hosts file.

func (Hosts) HasHostname

func (h Hosts) HasHostname(host string) bool

HasHostname return a bool if hostname in hosts file.

func (Hosts) HasIp

func (h Hosts) HasIp(ip string) bool

func (*Hosts) HostsPerLine

func (h *Hosts) HostsPerLine(count int)

func (*Hosts) IsWritable

func (h *Hosts) IsWritable() bool

IsWritable return ```true``` if hosts file is writable.

func (*Hosts) Load

func (h *Hosts) Load() error

Load the hosts file into ```l.Lines```. ```Load()``` is called by ```NewHosts()``` and ```Hosts.Flush()``` so you generally you won't need to call this yourself.

func (*Hosts) Remove

func (h *Hosts) Remove(ip string, hosts ...string) error

Remove an entry from the hosts file.

func (*Hosts) RemoveByHostname

func (h *Hosts) RemoveByHostname(host string) error

RemoveByHostname remove entries by hostname from the hosts file.

func (*Hosts) RemoveByIp

func (h *Hosts) RemoveByIp(ip string) error

func (*Hosts) RemoveDuplicateHosts

func (h *Hosts) RemoveDuplicateHosts()

func (*Hosts) RemoveDuplicateIps

func (h *Hosts) RemoveDuplicateIps()

func (*Hosts) SortByIp

func (h *Hosts) SortByIp()

SortByIp convert to net.IP and byte.Compare

func (*Hosts) SortHosts

func (h *Hosts) SortHosts()

type HostsLine

type HostsLine struct {
	IP      string
	Hosts   []string
	Raw     string
	Err     error
	Comment string
}

func NewHostsLine

func NewHostsLine(raw string) HostsLine

NewHostsLine return a new instance of ```HostsLine```.

func (*HostsLine) Combine

func (l *HostsLine) Combine(hostline HostsLine)

func (*HostsLine) HasComment

func (l *HostsLine) HasComment() bool

func (*HostsLine) IsComment

func (l *HostsLine) IsComment() bool

func (*HostsLine) IsMalformed

func (l *HostsLine) IsMalformed() bool

func (*HostsLine) IsValid

func (l *HostsLine) IsValid() bool

func (*HostsLine) RegenRaw

func (l *HostsLine) RegenRaw()

func (*HostsLine) RemoveDuplicateHosts

func (l *HostsLine) RemoveDuplicateHosts()

func (*HostsLine) SortHosts

func (l *HostsLine) SortHosts()

func (*HostsLine) ToRaw

func (l *HostsLine) ToRaw() string