util

Documentation

Overview

Package util implements various utility functions used in both testing and implementation of Kubernetes. Package util may not depend on any other package in the Kubernetes package tree.

Index

• func AllPtrFieldsNil(obj interface{}) bool
• func CompileRegexps(regexpStrings []string) ([]*regexp.Regexp, error)
• func ExecuteTemplate(w io.Writer, templateText string, data interface{}) error
• func ExecuteTemplateToString(templateText string, data interface{}) (string, error)
• func FileExists(filename string) (bool, error)
• func Int32Ptr(i int32) *int32
• func Int32PtrDerefOr(ptr *int32, def int32) int32
• func IntPtr(i int) *int
• func IntPtrDerefOr(ptr *int, def int) int
• func ReadDirNoStat(dirname string) ([]string, error)
• func Umask(mask int) (old int, err error)
• func UsingSystemdInitSystem() bool

Functions

func AllPtrFieldsNil

func AllPtrFieldsNil(obj interface{}) bool

Tests whether all pointer fields in a struct are nil. This is useful when, for example, an API struct is handled by plugins which need to distinguish "no plugin accepted this spec" from "this spec is empty".

This function is only valid for structs and pointers to structs. Any other type will cause a panic. Passing a typed nil pointer will return true.

func CompileRegexps

func CompileRegexps(regexpStrings []string) ([]*regexp.Regexp, error)

Takes a list of strings and compiles them into a list of regular expressions

func ExecuteTemplate

func ExecuteTemplate(w io.Writer, templateText string, data interface{}) error

ExecuteTemplate executes templateText with data and output written to w.

func ExecuteTemplateToString

func ExecuteTemplateToString(templateText string, data interface{}) (string, error)

func FileExists

func FileExists(filename string) (bool, error)

func Int32Ptr

func Int32Ptr(i int32) *int32

Int32Ptr returns a pointer to an int32

func Int32PtrDerefOr

func Int32PtrDerefOr(ptr *int32, def int32) int32

Int32PtrDerefOr dereference the int32 ptr and returns it i not nil, else returns def.

func IntPtr

func IntPtr(i int) *int

IntPtr returns a pointer to an int

func IntPtrDerefOr

func IntPtrDerefOr(ptr *int, def int) int

IntPtrDerefOr dereference the int ptr and returns it i not nil, else returns def.

func ReadDirNoStat

func ReadDirNoStat(dirname string) ([]string, error)

ReadDirNoStat returns a string of files/directories contained in dirname without calling lstat on them.

func Umask

func Umask(mask int) (old int, err error)

func UsingSystemdInitSystem

func UsingSystemdInitSystem() bool

Detects if using systemd as the init system Please note that simply reading /proc/1/cmdline can be misleading because some installation of various init programs can automatically make /sbin/init a symlink or even a renamed version of their main program. TODO(dchen1107): realiably detects the init system using on the system: systemd, upstart, initd, etc.