utils

Documentation

Overview

Copyright © 2021 Antoine Martin <antoine@openance.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func ExecuteIfExist(file string, fn func() error) error
• func ExecuteIfNotExist(file string, fn func() error) error
• func ExecuteOnExistence(file string, existence bool, fn func() error) error
• func Exists(path string) (bool, error)
• func GetOutboundIP() (net.IP, error)
• func IsOnWSL() bool
• func MoveFileIfExists(src string, dst string) error
• func RemoveDirectoryContents(dir string, predicate func(string) bool) error
• func WriteFile(filename string, data []byte, perm os.FileMode) error
• type CommandExecutor
  • func (c *CommandExecutor) Pipe(stdin io.Reader, combined bool, cmd string, arguments ...string) ([]byte, error)
  • func (c *CommandExecutor) Run(combined bool, cmd string, arguments ...string) ([]byte, error)
• type Executor
• type ExecutorFunction

Functions

func ExecuteIfExist

func ExecuteIfExist(file string, fn func() error) error

ExecuteIfExist executes the function fn if the file file exists.

func ExecuteIfNotExist

func ExecuteIfNotExist(file string, fn func() error) error

ExecuteIfNotExist executes the function fn if the file file doesn't exist.

func ExecuteOnExistence

func ExecuteOnExistence(file string, existence bool, fn func() error) error

ExecuteOnExistence executes the function fn if the file existence is the one given by the parameter.

func Exists

func Exists(path string) (bool, error)

Exists tells if file exists

func GetOutboundIP

func GetOutboundIP() (net.IP, error)

GetOutboundIP returns the preferred outbound ip of this machine

func IsOnWSL

func IsOnWSL() bool

func MoveFileIfExists

func MoveFileIfExists(src string, dst string) error

MoveFileIfExists moves the file src to the destination dst if it exists

func RemoveDirectoryContents

func RemoveDirectoryContents(dir string, predicate func(string) bool) error

func WriteFile

func WriteFile(filename string, data []byte, perm os.FileMode) error

Types

type CommandExecutor

type CommandExecutor struct {
}

func (*CommandExecutor) Pipe

func (c *CommandExecutor) Pipe(stdin io.Reader, combined bool, cmd string, arguments ...string) ([]byte, error)

func (*CommandExecutor) Run

func (c *CommandExecutor) Run(combined bool, cmd string, arguments ...string) ([]byte, error)

type Executor

type Executor interface {
	Run(combined bool, cmd string, arguments ...string) ([]byte, error)
	Pipe(stdin io.Reader, combined bool, cmd string, arguments ...string) ([]byte, error)
}

The Executor interface provices

var Exec Executor = &CommandExecutor{}

type ExecutorFunction

type ExecutorFunction = func(cmd string, arguments ...string) ([]byte, error)

ExecutorFunction is a function that exectues a command and returns its input