Struct starship::module::Module

pub struct Module<'a> { /* fields omitted */ }

A module is a collection of segments showing data for a single integration (e.g. The git module shows the current git branch and status)

Methods

impl<'a> Module<'a>

pub fn new(name: &str, config: Option<&'a Table>) -> Module<'a>

Creates a module with no segments.

pub fn new_segment(&mut self, name: &str, value: &str) -> &mut Segment

Get a reference to a newly created segment in the module

pub fn is_empty(&self) -> bool

Whether a module has any segments

pub fn get_prefix(&mut self) -> &mut Affix

Get the module's prefix

pub fn get_suffix(&mut self) -> &mut Affix

Get the module's suffix

pub fn set_style<T>(&mut self, style: T) -> &mut Module<'a> where
    T: Into<Style>, 

Sets the style of the segment.

Accepts either Color or Style.

pub fn ansi_strings(&self) -> Vec<ANSIString>

Returns a vector of colored ANSIString elements to be later used with ANSIStrings() to optimize ANSI codes

pub fn to_string_without_prefix(&self) -> String

pub fn config_value_str(&self, key: &str) -> Option<&str>

Get a module's config value as a string

pub fn config_value_i64(&self, key: &str) -> Option<i64>

Get a module's config value as an int

pub fn config_value_bool(&self, key: &str) -> Option<bool>

Get a module's config value as a bool

Trait Implementations

impl<'a> Display for Module<'a>

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

Formats the value using the given formatter.