Git::Raw::Stash(3pm)

📦
version 0.90 · 7 versions
, in ubuntu stonking

💖 Git::Raw::Stash 💖

okay bestie, gather round, because this is Git::Raw::Stash from the User Contributed Perl Documentation section, and it's literally the little helper that handles your stash game. 🎀

VERSION: version 0.90 ✨

🌸 DESCRIPTION 🌸

It's a helper class to manage stashes. That's it, that's the job. 💅

⚠️ WARNING: the API of this module is unstable and may change without warning. any change will be appropriately documented in the changelog, so like, no cap, but also stay on your toes. 🫶

✨ METHODS ✨

apply( $repo, $index, [\%stash_apply_opts] ) 🦋

Applies a single stashed state from the stash list. Cute, right? BUT. If local changes in the working directory conflict with the changes in the stash, this function throws a Git::Raw::Error exception with a Git::Raw::Error::EMERGECONFLICT error code. 😭

And if you're restoring untracked files or ignored files and there's a conflict when applying the modified files, then those files will remain in the working directory. yes, they stay. it's giving "we tried".

Valid fields for %stash_apply_opts include:

  • checkout_opts — see Git::Raw::Repository->checkout() for the deets 👀
  • flags
    • reinstate_index — try to reinstate not only the working tree's changes, but also the index's changes. both. she wants both. 👑
  • callbacks
    • apply_progress — progress notification function. The callback receives a single $progress value which may be any constant provided by Git::Raw::Stash::Progress. 📈

pop( $repo, $index, [\%stash_apply_opts] ) 💅

Applies a single stashed state from the stash list and then removes it from the list if successful. apply + yeet. periodt.

save( $repo, $stasher, $msg [, \@opts] ) 🎀

Saves the local modifications to a new stash. Non-default options may be specified by providing the optional @opts argument. If files were stashed, this function returns a Git::Raw::Commit object, otherwise undef. bestie, if nothing got stashed you get undef and you just have to live with that. 🙈

Valid fields for the @opts array are:

  • keep_index — all changes already added to the index are left intact in the working directory. The default is to also stash changes in the index. so like, by default she stashes the index too. 💜
  • include_untracked — all untracked files are also stashed and then cleaned up from the working directory. The default is to leave untracked files in the working directory. 🧚
  • include_ignored — all ignored files are also stashed and then cleaned up up from the working directory. The default is to leave ignored files in the working directory. ⭐

foreach( $repo, $callback ) 🌈

Runs $callback for every stash in the repo. The callback receives three arguments: the stash $index, the stash $message and the stash $commit, a Git::Raw::Commit object. A non-zero return value will stop the loop. so if you return truthy, she's done. main character decided. 🔥

drop( $repo, $index ) 💀

Removes a single stash from the stash list. bye girl. 👋

🫶 AUTHOR 🫶

Alessandro Ghedini <alexbio@cpan.org>

Jacques Germishuys <jacquesg@cpan.org>

Copyright 2012 Alessandro Ghedini.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

and that's the whole page, bestie 💖 this doc shipped as part of perl v5.42.3, dated 2026-08-19, and it lives in the User Contributed Perl Documentation corner of the manual. slay, go stash something. ✨🌸🦋

📦 where this page comes from