class Git::Commands::Stash::Apply

Apply stashed changes to the working directory

Applies the changes recorded in a stash to the working tree. Unlike {Pop}, this does not remove the stash from the stash list.

@example Apply the latest stash

Git::Commands::Stash::Apply.new(execution_context).call

@example Apply a specific stash

Git::Commands::Stash::Apply.new(execution_context).call('stash@\\{2}')

@example Apply and restore index state

Git::Commands::Stash::Apply.new(execution_context).call(index: true)

@note ‘arguments` block audited against git-scm.com/docs/git-stash/2.53.0

@see Git::Commands::Stash Git::Commands::Stash for usage examples

@see git-scm.com/docs/git-stash git-stash documentation

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/stash/apply.rb, line 75
def call(*, **)
  super
end

@overload call(**options)

Apply the latest stash

@param options [Hash] command options

@option options [Boolean, nil] :index (nil) restore the index state as well

@option options [Boolean, nil] :quiet (nil) suppress informational messages

  Alias: :q

@raise [ArgumentError] if unsupported options are provided

@overload call(stash, **options)

Apply a specific stash

@param stash [String] stash reference (e.g., 'stash@\\{0}', '0')

@param options [Hash] command options

@option options [Boolean, nil] :index (nil) restore the index state as well

@option options [Boolean, nil] :quiet (nil) suppress informational messages

  Alias: :q

@raise [ArgumentError] if unsupported options are provided

@return [Git::CommandLine::Result] the result of calling ‘git stash apply`

@raise [Git::FailedError] if git exits with a non-zero exit status

@api public

Calls superclass method Git::Commands::Base::call