numorstring

Documentation

Overview

package numorstring is copied from libcalico-go so that we can convert felix env vars which map to felixconfiguration fields of type numorstring.

Index

• type Port
  • func NamedPort(name string) Port
  • func PortFromRange(minPort, maxPort uint16) (Port, error)
  • func PortFromString(s string) (Port, error)
  • func SinglePort(port uint16) Port

Types

type Port

type Port struct {
	MinPort  uint16 `json:"minPort,omitempty"`
	MaxPort  uint16 `json:"maxPort,omitempty"`
	PortName string `json:"portName" validate:"omitempty,portName"`
}

Port represents either a range of numeric ports or a named port.

• For a named port, set the PortName, leaving MinPort and MaxPort as 0.
• For a port range, set MinPort and MaxPort to the (inclusive) port numbers. Set PortName to "".
• For a single port, set MinPort = MaxPort and PortName = "".

func NamedPort

func NamedPort(name string) Port

func PortFromRange

func PortFromRange(minPort, maxPort uint16) (Port, error)

PortFromRange creates a Port struct representing a range of ports.

func PortFromString

func PortFromString(s string) (Port, error)

PortFromString creates a Port struct from its string representation. A port may either be single value "1234", a range of values "100:200" or a named port: "name".

func SinglePort

func SinglePort(port uint16) Port

SinglePort creates a Port struct representing a single port.