claude_code_statusline_core::modules::git_branch

Struct GitBranchModule

pub struct GitBranchModule;

Expand description

Module that displays the current Git branch

Shows the branch name when on a branch, or a short SHA when in detached HEAD state. Only displays when inside a git repository.

§Configuration

[git_branch]
format = "[$symbol$branch(:$remote_branch)]($style)"
style = "bold purple"
symbol = ""
disabled = false

§Display Behavior

Branch name: Shows current branch (e.g., “main”, “feature/xyz”)
Detached HEAD: Shows short commit SHA
Outside repo: Module is hidden

Implementations§

Source §

impl GitBranchModule

Source

pub fn new() -> Self

Source

pub fn from_context(_context: &Context) -> Self

Trait Implementations§

Source §

impl Default for GitBranchModule

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Source §

impl Module for GitBranchModule

Source §

fn name(&self) -> &str

Returns the name of the module

Source §

fn should_display(&self, context: &Context, config: &dyn ModuleConfig) -> bool

Determines if this module should be displayed

Source §

fn render(&self, context: &Context, config: &dyn ModuleConfig) -> String

Renders the module’s output as a string

Auto Trait Implementations§

§

impl UnwindSafe for GitBranchModule

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §