exec

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• func Exec(timeout time.Duration, cmdName string, args ...string) (string, string, error)
• type CommandBuilder
  • func NewCommandBuilder(options ...CommandBuilderOption) (*CommandBuilder, error)
  • func (o *CommandBuilder) ApplyOptions(options ...CommandBuilderOption) *CommandBuilder
  • func (c *CommandBuilder) Exec(cmdName string, args ...string) (string, string, error)
• type CommandBuilderOption
  • func WithTimeout(timeout time.Duration) CommandBuilderOption
• type CommandBuilderOptionFunc
• type EmptyCommandBuilderOption

Functions

func Exec

func Exec(
	timeout time.Duration,
	cmdName string,
	args ...string,
) (string, string, error)

timout ms

Types

type CommandBuilder

type CommandBuilder struct {
	// contains filtered or unexported fields
}

func NewCommandBuilder

func NewCommandBuilder(
	options ...CommandBuilderOption,
) (*CommandBuilder, error)

func (*CommandBuilder) ApplyOptions

func (o *CommandBuilder) ApplyOptions(
	options ...CommandBuilderOption,
) *CommandBuilder

func (*CommandBuilder) Exec

func (c *CommandBuilder) Exec(cmdName string,
	args ...string,
) (string, string, error)

Exec return output result, err messgae, error

type CommandBuilderOption

type CommandBuilderOption interface {
	// contains filtered or unexported methods
}

func WithTimeout

func WithTimeout(timeout time.Duration) CommandBuilderOption

timeout

type CommandBuilderOptionFunc

type CommandBuilderOptionFunc func(*CommandBuilder)

CopyDirOptionFunc wraps a function that modifies CopyDir into an implementation of the CopyDirOption interface.

type EmptyCommandBuilderOption

type EmptyCommandBuilderOption struct{}

EmptyCommandBuilderOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.