refactor: Use pub(crate) fn instead of pub fn

StGit does not want to be mistaken for a library.

Author: jpgrayson

src/cmd/completion/shstream.rs

@@ -16,7 +16,7 @@ pub(crate) struct ShStream {
 
 impl ShStream {
     /// Create a new [`ShStream`] instance.
-    pub fn new() -> Self {
+    pub(crate) fn new() -> Self {
         Self {
             buffer: String::new(),
             indent_level: 0,
@@ -25,28 +25,28 @@ impl ShStream {
     }
 
     /// Insert a raw string into the stream.
-    pub fn raw(&mut self, s: &str) {
+    pub(crate) fn raw(&mut self, s: &str) {
         if !self.is_bol() {
             self.buffer.push('\n');
         }
         self.buffer.push_str(s);
     }
 
     /// Increase the indentation level used for subsequent lines.
-    pub fn indent(&mut self) {
+    pub(crate) fn indent(&mut self) {
         self.indent_level += 1;
     }
 
     /// Decrease the indentation level used for subsequent lines.
-    pub fn dedent(&mut self) {
+    pub(crate) fn dedent(&mut self) {
         assert!(self.indent_level > 0);
         self.indent_level -= 1;
     }
 
     /// Insert a line into the stream.
     ///
     /// The line is prefixed with indentation and suffixed with a newline character.
-    pub fn line(&mut self, line: &str) {
+    pub(crate) fn line(&mut self, line: &str) {
         if !self.is_bol() {
             self.buffer.push('\n');
         }
@@ -58,7 +58,7 @@ impl ShStream {
     }
 
     /// Ensure a blank line precedes subsequent lines.
-    pub fn ensure_blank_line(&mut self) {
+    pub(crate) fn ensure_blank_line(&mut self) {
         if !self.buffer.is_empty() && !self.buffer.ends_with("\n\n") {
             if self.buffer.ends_with('\n') {
                 self.buffer.push('\n');
@@ -68,7 +68,7 @@ impl ShStream {
         }
     }
 
-    pub fn end_line(&mut self) {
+    pub(crate) fn end_line(&mut self) {
         if !self.is_bol() {
             self.buffer.push('\n');
         }
@@ -77,7 +77,7 @@ impl ShStream {
     /// Insert slice of lines into the stream.
     ///
     /// Each line is prefixed with the current indentation level.
-    pub fn lines(&mut self, lines: &[&str]) {
+    pub(crate) fn lines(&mut self, lines: &[&str]) {
         for line in lines {
             self.line(line);
         }
@@ -88,7 +88,7 @@ impl ShStream {
     /// If the word starts a line, it will be indented to the current indentation level.
     /// Otherwise, a single space will be used to separate this word from any preceding
     /// word.
-    pub fn word(&mut self, word: &str) {
+    pub(crate) fn word(&mut self, word: &str) {
         if self.is_bol() {
             self.push_indent();
         } else if !self.buffer.ends_with(self.word_sep) {
@@ -98,12 +98,12 @@ impl ShStream {
     }
 
     /// Set the inter-word separator character.
-    pub fn word_sep(&mut self, separator: char) {
+    pub(crate) fn word_sep(&mut self, separator: char) {
         self.word_sep = separator;
     }
 
     /// Return byte slice of the stream's contents.
-    pub fn as_bytes(&self) -> &[u8] {
+    pub(crate) fn as_bytes(&self) -> &[u8] {
         self.buffer.as_bytes()
     }
 

src/stack/stack.rs

@@ -96,7 +96,7 @@ impl<'repo> Stack<'repo> {
     /// The current branch is used if the optional branch name is not provided.
     ///
     /// An error will be returned if there is no StGit stack associated with the branch.
-    pub fn from_branch(repo: &'repo git2::Repository, branch_name: Option<&str>) -> Result<Self> {
+    pub(crate) fn from_branch(repo: &'repo git2::Repository, branch_name: Option<&str>) -> Result<Self> {
         let branch = repo.get_branch(branch_name)?;
         let branch_name = get_branch_name(&branch)?;
         let branch_head = branch.get().peel_to_commit()?;
@@ -127,14 +127,14 @@ impl<'repo> Stack<'repo> {
     }
 
     /// Check whether the stack is marked as protected in the config.
-    pub fn is_protected(&self, config: &git2::Config) -> bool {
+    pub(crate) fn is_protected(&self, config: &git2::Config) -> bool {
         let name = &self.branch_name;
         let key = format!("branch.{name}.stgit.protect");
         config.get_bool(&key).unwrap_or(false)
     }
 
     /// Set the stack's protected state in the config.
-    pub fn set_protected(&self, config: &mut git2::Config, protect: bool) -> Result<()> {
+    pub(crate) fn set_protected(&self, config: &mut git2::Config, protect: bool) -> Result<()> {
         let name = &self.branch_name;
         let key = format!("branch.{name}.stgit.protect");
         if protect {
@@ -155,12 +155,12 @@ impl<'repo> Stack<'repo> {
     }
 
     /// Check whether the stack's recorded head matches the branch's head.
-    pub fn is_head_top(&self) -> bool {
+    pub(crate) fn is_head_top(&self) -> bool {
         self.state.head.id() == self.branch_head.id()
     }
 
     /// Return an error if the stack's recorded head differs from the branch's head.
-    pub fn check_head_top_mismatch(&self) -> Result<()> {
+    pub(crate) fn check_head_top_mismatch(&self) -> Result<()> {
         if self.state.applied.is_empty() || self.is_head_top() {
             Ok(())
         } else {
@@ -173,7 +173,7 @@ impl<'repo> Stack<'repo> {
     }
 
     /// Re-commit stack state with updated branch head.
-    pub fn log_external_mods(self, message: Option<&str>) -> Result<Self> {
+    pub(crate) fn log_external_mods(self, message: Option<&str>) -> Result<Self> {
         let state_ref = self.repo.find_reference(&self.refname)?;
         let prev_state_commit = state_ref.peel_to_commit()?;
         let prev_state_commit_id = prev_state_commit.id();

src/stack/state.rs

@@ -157,12 +157,12 @@ impl<'repo> StackState<'repo> {
     }
 
     /// Iterator over all patches.
-    pub fn all_patches(&self) -> AllPatches<'_> {
+    pub(crate) fn all_patches(&self) -> AllPatches<'_> {
         AllPatches::new(&self.applied, &self.unapplied, &self.hidden)
     }
 
     /// Return commit of topmost patch, or stack base if no patches applied.
-    pub fn top(&self) -> &git2::Commit<'repo> {
+    pub(crate) fn top(&self) -> &git2::Commit<'repo> {
         if let Some(patchname) = self.applied.last() {
             &self.patches[patchname].commit
         } else {
@@ -171,7 +171,7 @@ impl<'repo> StackState<'repo> {
     }
 
     /// Create updated state with new head and prev commits.
-    pub fn advance_head(
+    pub(crate) fn advance_head(
         self,
         new_head: git2::Commit<'repo>,
         prev_state: git2::Commit<'repo>,
@@ -190,7 +190,7 @@ impl<'repo> StackState<'repo> {
     /// are not subject to garbage collection, stack state commit objects have parent
     /// commits with tree content of the associated branch in addition to a "regular"
     /// parent commit from the stack state branch.
-    pub fn commit(
+    pub(crate) fn commit(
         &self,
         repo: &'repo git2::Repository,
         update_ref: Option<&str>,

src/stack/upgrade.rs

@@ -15,7 +15,7 @@ use super::serde::{RawPatchState, RawStackState};
 use crate::{patchname::PatchName, stack::state::StackState};
 
 /// Upgrade stack state metadata to most recent version.
-pub fn stack_upgrade(repo: &git2::Repository, branch_name: &str) -> Result<()> {
+pub(crate) fn stack_upgrade(repo: &git2::Repository, branch_name: &str) -> Result<()> {
     let refname_v4 = state_refname_from_branch_name_v4(branch_name);
 
     if let Ok(mut stack_ref_v4) = repo.find_reference(&refname_v4) {