utils

package

v0.2.4 Latest Latest Go to latest Published: Feb 19, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kaweezle/iknite

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ExecuteIfExist ¶ added in v0.1.8

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 ¶ added in v0.1.8

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 ¶ added in v0.2.0

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 ¶ added in v0.2.0

type CommandExecutor struct {
}

func (*CommandExecutor) Pipe ¶ added in v0.2.0

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

func (*CommandExecutor) Run ¶ added in v0.2.0

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

type Executor ¶ added in v0.2.0

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 ¶ added in v0.2.0

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

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL