Struct GitBranchSegment 

pub struct GitBranchSegment { /* private fields */ }

Implementations

impl GitBranchSegment

pub fn from_extras( extras: &BTreeMap<String, Value>, warn: &mut impl FnMut(&str), ) -> Self

Parse the [segments.git_branch] extras bag. Unknown values warn and fall back to defaults. dirty.format = "counts" warns and falls back to “indicator”.

Trait Implementations

impl Default for GitBranchSegment

fn default() -> GitBranchSegment

Returns the “default value” for a type.

impl Segment for GitBranchSegment

fn data_deps(&self) -> &'static [DataDep]

Declare which data sources this segment reads. The runtime computes the union across all enabled segments and lazy-fetches only those sources. Defaults to the stdin payload only; segments that read other sources must override. See docs/specs/data-fetching.md §Segment dependency declaration.

fn defaults(&self) -> SegmentDefaults

Layout defaults (priority, width bounds, truncatable opt-in). User config may override each field via OverriddenSegment. Implementations must be O(1), do no I/O, and avoid allocation: the layout engine snapshots this at collect time and the [LineItem::Debug] impl reads it for dbg! / panic-backtrace formatting.

fn render(&self, ctx: &DataContext, rc: &RenderContext) -> RenderResult

Render this segment for the given context.

fn shrink_to_fit( &self, ctx: &DataContext, _rc: &RenderContext, target: u16, ) -> Option<RenderedSegment>

Layout-pressure-aware compaction hook. The reflow loop calls this on any segment under width pressure (truncatable or not), asking whether it can produce a render at most target cells wide. It runs before truncatable end-ellipsis truncation, so segment-side intelligence beats generic string clipping when both apply. Default returns None (no compact form available; engine falls through to truncatable or drop). Segments with structured tail content override to shed decoration while keeping the signal-bearing prefix.