Skip to main content

SegmentDefaults

Struct SegmentDefaults 

Source
#[non_exhaustive]
pub struct SegmentDefaults { pub priority: u8, pub width: Option<WidthBounds>, pub truncatable: bool, }
Expand description

Layout intent declared by a segment; user config may override each field.

Under width pressure the engine drops segments in descending priority order: 255 drops first, 0 never drops. Default 128. Ties break by position: the right-most segment drops first.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§priority: u8§width: Option<WidthBounds>§truncatable: bool

May the layout engine shrink this segment under width pressure before dropping it? Default false — only prose-like segments (workspace name, branch name) opt in. Numeric or structured segments leave this false: a half-cut percentage reads as the wrong number, which is worse than no number. See docs/specs/segment-system.md §Layout algorithm.

Implementations§

Source§

impl SegmentDefaults

Source

pub fn with_priority(priority: u8) -> Self

Constructor shorthand for the common case of “default layout intent with a specific priority.” Chainable with Self::with_width and Self::with_truncatable.

Source

pub fn with_width(self, bounds: WidthBounds) -> Self

Chainable setter for width bounds.

Source

pub fn with_truncatable(self, truncatable: bool) -> Self

Chainable setter for the truncate-before-drop opt-in.

Trait Implementations§

Source§

impl Clone for SegmentDefaults

Source§

fn clone(&self) -> SegmentDefaults

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SegmentDefaults

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SegmentDefaults

Source§

fn default() -> Self

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

impl PartialEq for SegmentDefaults

Source§

fn eq(&self, other: &SegmentDefaults) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for SegmentDefaults

Source§

impl Eq for SegmentDefaults

Source§

impl StructuralPartialEq for SegmentDefaults

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.