Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EditOptions ¶ added in v1.7.1
type EditOptions struct { resource.FilenameOptions Output string WindowsLineEndings bool cmdutil.ValidateOptions Mapper meta.RESTMapper ResourceMapper *resource.Mapper OriginalResult *resource.Result Encoder runtime.Encoder EditMode EditMode CmdNamespace string ApplyAnnotation bool Record bool ChangeCause string Include3rdParty bool Out io.Writer ErrOut io.Writer // contains filtered or unexported fields }
EditOptions contains all the options for running edit cli command.
func (*EditOptions) Run ¶ added in v1.7.1
func (o *EditOptions) Run() error
func (*EditOptions) Validate ¶ added in v1.7.1
func (o *EditOptions) Validate() error
Validate checks the EditOptions to see if there is sufficient information to run the command.
type Editor ¶
func NewDefaultEditor ¶
NewDefaultEditor creates a struct Editor that uses the OS environment to locate the editor program, looking at EDITOR environment variable to find the proper command line. If the provided editor has no spaces, or no quotes, it is treated as a bare command to be loaded. Otherwise, the string will be passed to the user's shell for execution.
func (Editor) Launch ¶
Launch opens the described or returns an error. The TTY will be protected, and SIGQUIT, SIGTERM, and SIGINT will all be trapped.
func (Editor) LaunchTempFile ¶
LaunchTempFile reads the provided stream into a temporary file in the given directory and file prefix, and then invokes Launch with the path of that file. It will return the contents of the file after launch, any errors that occur, and the path of the temporary file so the caller can clean it up as needed.