pub struct Input<M: Display> { /* private fields */ }
Expand description
Input
struct
§Examples
use may_clack::{input, cancel};
let answer = input("message")
.initial_value("initial_value")
.validate(|x| x.find(char::is_uppercase).map(|_| "only use lowercase characters"))
.cancel(do_cancel)
.interact()?;
println!("answer {:?}", answer);
fn do_cancel() {
cancel!("operation cancelled");
std::process::exit(1);
}
Implementations§
source§impl<M: Display> Input<M>
impl<M: Display> Input<M>
sourcepub fn placeholder<S: ToString>(&mut self, placeholder: S) -> &mut Self
pub fn placeholder<S: ToString>(&mut self, placeholder: S) -> &mut Self
Specify a placeholder.
§Examples
use may_clack::input;
let answer = input("message").placeholder("placeholder").required()?;
println!("answer {:?}", answer);
Examples found in repository?
examples/to_string.rs (line 18)
13 14 15 16 17 18 19 20 21 22 23 24 25 26
fn main() -> Result<(), ClackError> {
println!();
intro!(" to_string ".reversed());
let int = input("int").initial_value(23).parse::<i32>()?;
let unit = input("struct").placeholder(Name).required()?;
outro!();
println!("int {:?}", int);
println!("unit {:?}", unit);
Ok(())
}
More examples
examples/full.rs (line 14)
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
fn main() -> Result<(), ClackError> {
println!();
intro!(" full ".reversed());
info!("visit the documentation at https://docs.rs/may-clack");
let do_input = input("input")
.placeholder("placeholder")
.cancel(do_cancel)
.required()?;
let do_multi_input = multi_input("multi input")
.max(4)
.cancel(do_cancel)
.interact()?;
let do_confirm = confirm("confirm")
.prompts("true", "false")
.cancel(do_cancel)
.interact()?;
let do_multi_select = multi_select("multi select")
.option("opt1", "option 1")
.option("opt2", "option 2")
.option_hint("opt3", "option 3", "hint")
.cancel(do_cancel)
.interact()?;
let do_select = select("select")
.option("val1", "value 1")
.option("val2", "value 2")
.option_hint("val 3", "value 3", "hint")
.cancel(do_cancel)
.interact()?;
outro!();
println!("input {:?}", do_input);
println!("confirm {:?}", do_confirm);
println!("multi_input {:?}", do_multi_input);
println!("multi_select {:?}", do_multi_select);
println!("select {:?}", do_select);
Ok(())
}
sourcepub fn maybe_initial<T: Borrow<Option<S>>, S: ToString>(
&mut self,
initial: T
) -> &mut Self
pub fn maybe_initial<T: Borrow<Option<S>>, S: ToString>( &mut self, initial: T ) -> &mut Self
Maybe specify an initial value.
§Examples
use may_clack::input;
let answer = input("message").maybe_initial(Some("initial")).required()?;
let answer = input("message").maybe_initial(None::<&str>).required()?;
Examples found in repository?
examples/maybe_initial.rs (line 12)
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
fn main() -> Result<(), ClackError> {
println!();
intro!(" maybe_initial ".reversed());
let opt = Some("test");
#[allow(clippy::needless_borrows_for_generic_args)]
let ref_opt = input("message")
.maybe_initial(&opt)
.cancel(do_cancel)
.required()?;
let opt = input("message")
.maybe_initial(opt)
.cancel(do_cancel)
.required()?;
let none = input("message")
.maybe_initial(None::<&str>)
.cancel(do_cancel)
.required()?;
outro!();
println!("ref_opt {:?}", ref_opt);
println!("opt {:?}", opt);
println!("none {:?}", none);
Ok(())
}
sourcepub fn initial_value<S: ToString>(&mut self, initial_value: S) -> &mut Self
pub fn initial_value<S: ToString>(&mut self, initial_value: S) -> &mut Self
Specify the initial value.
§Examples
use may_clack::input;
let answer = input("message").initial_value("initial_value").interact()?;
println!("answer {:?}", answer);
Examples found in repository?
examples/to_string.rs (line 17)
13 14 15 16 17 18 19 20 21 22 23 24 25 26
fn main() -> Result<(), ClackError> {
println!();
intro!(" to_string ".reversed());
let int = input("int").initial_value(23).parse::<i32>()?;
let unit = input("struct").placeholder(Name).required()?;
outro!();
println!("int {:?}", int);
println!("unit {:?}", unit);
Ok(())
}
sourcepub fn validate<F>(&mut self, validate: F) -> &mut Self
pub fn validate<F>(&mut self, validate: F) -> &mut Self
Specify a validation function.
On a successful validation, return a None
from the closure,
and on an unsuccessful validation return a Some<&'static str>
with the error message.
§Examples
use may_clack::input;
let answer = input("message")
.validate(|x| (!x.is_ascii()).then_some("only use ascii characters"))
.interact()?;
println!("answer {:?}", answer);
Examples found in repository?
examples/validate.rs (line 10)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
fn main() -> Result<(), ClackError> {
println!();
intro!(" validate ".reversed());
let do_validate_input = input("validate single (only use ascii)")
.validate(|x| (!x.is_ascii()).then_some("only use ascii characters"))
.cancel(do_cancel)
.required()?;
let do_validate_multi_input = multi_input("validate multi (only use lowercase)")
.validate(|x| {
x.find(char::is_uppercase)
.map(|_| "only use lowercase characters")
})
.cancel(do_cancel)
.interact()?;
let do_parse_input = input("parse to u8").cancel(do_cancel).parse::<u8>()?;
let do_maybe_parse = input("maybe parse to ipv4 addr").maybe_parse::<Ipv4Addr>()?;
let do_parse_multi = multi_input("parse multiple to u8")
.cancel(do_cancel)
.parse::<u8>()?;
outro!();
println!("single {:?}", do_validate_input);
println!("multi {:?}", do_validate_multi_input);
println!("parse single {:?}", do_parse_input);
println!("maybe parse single {:?}", do_maybe_parse);
println!("parse multi {:?}", do_parse_multi);
Ok(())
}
sourcepub fn cancel<F>(&mut self, cancel: F) -> &mut Selfwhere
F: Fn() + 'static,
pub fn cancel<F>(&mut self, cancel: F) -> &mut Selfwhere
F: Fn() + 'static,
Specify function to call on cancel.
§Examples
use may_clack::{input, cancel};
let answer = input("message").cancel(do_cancel).interact()?;
println!("answer {:?}", answer);
fn do_cancel() {
cancel!("operation cancelled");
panic!("operation cancelled");
}
Examples found in repository?
examples/maybe_initial.rs (line 13)
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
fn main() -> Result<(), ClackError> {
println!();
intro!(" maybe_initial ".reversed());
let opt = Some("test");
#[allow(clippy::needless_borrows_for_generic_args)]
let ref_opt = input("message")
.maybe_initial(&opt)
.cancel(do_cancel)
.required()?;
let opt = input("message")
.maybe_initial(opt)
.cancel(do_cancel)
.required()?;
let none = input("message")
.maybe_initial(None::<&str>)
.cancel(do_cancel)
.required()?;
outro!();
println!("ref_opt {:?}", ref_opt);
println!("opt {:?}", opt);
println!("none {:?}", none);
Ok(())
}
More examples
examples/validate.rs (line 11)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
fn main() -> Result<(), ClackError> {
println!();
intro!(" validate ".reversed());
let do_validate_input = input("validate single (only use ascii)")
.validate(|x| (!x.is_ascii()).then_some("only use ascii characters"))
.cancel(do_cancel)
.required()?;
let do_validate_multi_input = multi_input("validate multi (only use lowercase)")
.validate(|x| {
x.find(char::is_uppercase)
.map(|_| "only use lowercase characters")
})
.cancel(do_cancel)
.interact()?;
let do_parse_input = input("parse to u8").cancel(do_cancel).parse::<u8>()?;
let do_maybe_parse = input("maybe parse to ipv4 addr").maybe_parse::<Ipv4Addr>()?;
let do_parse_multi = multi_input("parse multiple to u8")
.cancel(do_cancel)
.parse::<u8>()?;
outro!();
println!("single {:?}", do_validate_input);
println!("multi {:?}", do_validate_multi_input);
println!("parse single {:?}", do_parse_input);
println!("maybe parse single {:?}", do_maybe_parse);
println!("parse multi {:?}", do_parse_multi);
Ok(())
}
examples/full.rs (line 15)
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
fn main() -> Result<(), ClackError> {
println!();
intro!(" full ".reversed());
info!("visit the documentation at https://docs.rs/may-clack");
let do_input = input("input")
.placeholder("placeholder")
.cancel(do_cancel)
.required()?;
let do_multi_input = multi_input("multi input")
.max(4)
.cancel(do_cancel)
.interact()?;
let do_confirm = confirm("confirm")
.prompts("true", "false")
.cancel(do_cancel)
.interact()?;
let do_multi_select = multi_select("multi select")
.option("opt1", "option 1")
.option("opt2", "option 2")
.option_hint("opt3", "option 3", "hint")
.cancel(do_cancel)
.interact()?;
let do_select = select("select")
.option("val1", "value 1")
.option("val2", "value 2")
.option_hint("val 3", "value 3", "hint")
.cancel(do_cancel)
.interact()?;
outro!();
println!("input {:?}", do_input);
println!("confirm {:?}", do_confirm);
println!("multi_input {:?}", do_multi_input);
println!("multi_select {:?}", do_multi_select);
println!("select {:?}", do_select);
Ok(())
}
sourcepub fn parse<T: FromStr + Display>(&self) -> Result<T, ClackError>
pub fn parse<T: FromStr + Display>(&self) -> Result<T, ClackError>
Like Input::required()
, but parses the value before returning.
Useful for getting number inputs.
§Examples
use may_clack::input;
let answer: i32 = input("message").parse::<i32>()?;
println!("answer {:?}", answer);
Examples found in repository?
examples/to_string.rs (line 17)
13 14 15 16 17 18 19 20 21 22 23 24 25 26
fn main() -> Result<(), ClackError> {
println!();
intro!(" to_string ".reversed());
let int = input("int").initial_value(23).parse::<i32>()?;
let unit = input("struct").placeholder(Name).required()?;
outro!();
println!("int {:?}", int);
println!("unit {:?}", unit);
Ok(())
}
More examples
examples/validate.rs (line 20)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
fn main() -> Result<(), ClackError> {
println!();
intro!(" validate ".reversed());
let do_validate_input = input("validate single (only use ascii)")
.validate(|x| (!x.is_ascii()).then_some("only use ascii characters"))
.cancel(do_cancel)
.required()?;
let do_validate_multi_input = multi_input("validate multi (only use lowercase)")
.validate(|x| {
x.find(char::is_uppercase)
.map(|_| "only use lowercase characters")
})
.cancel(do_cancel)
.interact()?;
let do_parse_input = input("parse to u8").cancel(do_cancel).parse::<u8>()?;
let do_maybe_parse = input("maybe parse to ipv4 addr").maybe_parse::<Ipv4Addr>()?;
let do_parse_multi = multi_input("parse multiple to u8")
.cancel(do_cancel)
.parse::<u8>()?;
outro!();
println!("single {:?}", do_validate_input);
println!("multi {:?}", do_validate_multi_input);
println!("parse single {:?}", do_parse_input);
println!("maybe parse single {:?}", do_maybe_parse);
println!("parse multi {:?}", do_parse_multi);
Ok(())
}
sourcepub fn maybe_parse<T: FromStr + Display>(&self) -> Result<Option<T>, ClackError>
pub fn maybe_parse<T: FromStr + Display>(&self) -> Result<Option<T>, ClackError>
Like Input::parse()
, but it also allows empty line submits like Input::interact()
.
use may_clack::input;
use std::net::Ipv4Addr;
let answer = input("message").maybe_parse::<Ipv4Addr>()?;
println!("answer {:?}", answer);
Examples found in repository?
examples/validate.rs (line 21)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
fn main() -> Result<(), ClackError> {
println!();
intro!(" validate ".reversed());
let do_validate_input = input("validate single (only use ascii)")
.validate(|x| (!x.is_ascii()).then_some("only use ascii characters"))
.cancel(do_cancel)
.required()?;
let do_validate_multi_input = multi_input("validate multi (only use lowercase)")
.validate(|x| {
x.find(char::is_uppercase)
.map(|_| "only use lowercase characters")
})
.cancel(do_cancel)
.interact()?;
let do_parse_input = input("parse to u8").cancel(do_cancel).parse::<u8>()?;
let do_maybe_parse = input("maybe parse to ipv4 addr").maybe_parse::<Ipv4Addr>()?;
let do_parse_multi = multi_input("parse multiple to u8")
.cancel(do_cancel)
.parse::<u8>()?;
outro!();
println!("single {:?}", do_validate_input);
println!("multi {:?}", do_validate_multi_input);
println!("parse single {:?}", do_parse_input);
println!("maybe parse single {:?}", do_maybe_parse);
println!("parse multi {:?}", do_parse_multi);
Ok(())
}
sourcepub fn required(&self) -> Result<String, ClackError>
pub fn required(&self) -> Result<String, ClackError>
Like Input::interact()
, but does not return an empty line.
§Examples
use may_clack::input;
let answer = input("message").required()?;
println!("answer {:?}", answer);
Examples found in repository?
examples/to_string.rs (line 18)
13 14 15 16 17 18 19 20 21 22 23 24 25 26
fn main() -> Result<(), ClackError> {
println!();
intro!(" to_string ".reversed());
let int = input("int").initial_value(23).parse::<i32>()?;
let unit = input("struct").placeholder(Name).required()?;
outro!();
println!("int {:?}", int);
println!("unit {:?}", unit);
Ok(())
}
More examples
examples/maybe_initial.rs (line 14)
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
fn main() -> Result<(), ClackError> {
println!();
intro!(" maybe_initial ".reversed());
let opt = Some("test");
#[allow(clippy::needless_borrows_for_generic_args)]
let ref_opt = input("message")
.maybe_initial(&opt)
.cancel(do_cancel)
.required()?;
let opt = input("message")
.maybe_initial(opt)
.cancel(do_cancel)
.required()?;
let none = input("message")
.maybe_initial(None::<&str>)
.cancel(do_cancel)
.required()?;
outro!();
println!("ref_opt {:?}", ref_opt);
println!("opt {:?}", opt);
println!("none {:?}", none);
Ok(())
}
examples/validate.rs (line 12)
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
fn main() -> Result<(), ClackError> {
println!();
intro!(" validate ".reversed());
let do_validate_input = input("validate single (only use ascii)")
.validate(|x| (!x.is_ascii()).then_some("only use ascii characters"))
.cancel(do_cancel)
.required()?;
let do_validate_multi_input = multi_input("validate multi (only use lowercase)")
.validate(|x| {
x.find(char::is_uppercase)
.map(|_| "only use lowercase characters")
})
.cancel(do_cancel)
.interact()?;
let do_parse_input = input("parse to u8").cancel(do_cancel).parse::<u8>()?;
let do_maybe_parse = input("maybe parse to ipv4 addr").maybe_parse::<Ipv4Addr>()?;
let do_parse_multi = multi_input("parse multiple to u8")
.cancel(do_cancel)
.parse::<u8>()?;
outro!();
println!("single {:?}", do_validate_input);
println!("multi {:?}", do_validate_multi_input);
println!("parse single {:?}", do_parse_input);
println!("maybe parse single {:?}", do_maybe_parse);
println!("parse multi {:?}", do_parse_multi);
Ok(())
}
examples/full.rs (line 16)
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
fn main() -> Result<(), ClackError> {
println!();
intro!(" full ".reversed());
info!("visit the documentation at https://docs.rs/may-clack");
let do_input = input("input")
.placeholder("placeholder")
.cancel(do_cancel)
.required()?;
let do_multi_input = multi_input("multi input")
.max(4)
.cancel(do_cancel)
.interact()?;
let do_confirm = confirm("confirm")
.prompts("true", "false")
.cancel(do_cancel)
.interact()?;
let do_multi_select = multi_select("multi select")
.option("opt1", "option 1")
.option("opt2", "option 2")
.option_hint("opt3", "option 3", "hint")
.cancel(do_cancel)
.interact()?;
let do_select = select("select")
.option("val1", "value 1")
.option("val2", "value 2")
.option_hint("val 3", "value 3", "hint")
.cancel(do_cancel)
.interact()?;
outro!();
println!("input {:?}", do_input);
println!("confirm {:?}", do_confirm);
println!("multi_input {:?}", do_multi_input);
println!("multi_select {:?}", do_multi_select);
println!("select {:?}", do_select);
Ok(())
}
sourcepub fn interact(&self) -> Result<Option<String>, ClackError>
pub fn interact(&self) -> Result<Option<String>, ClackError>
Waits for the user to submit a line of text.
Returns None
on an empty line and Some::<String>
otherwise.
§Examples
use may_clack::{input, cancel};
let answer = input("message")
.initial_value("initial_value")
.validate(|x| x.parse::<u32>().err().map(|_| "invalid u32"))
.cancel(do_cancel)
.interact()?;
println!("answer {:?}", answer);
fn do_cancel() {
cancel!("operation cancelled");
std::process::exit(1);
}
Auto Trait Implementations§
impl<M> Freeze for Input<M>where
M: Freeze,
impl<M> !RefUnwindSafe for Input<M>
impl<M> !Send for Input<M>
impl<M> !Sync for Input<M>
impl<M> Unpin for Input<M>where
M: Unpin,
impl<M> !UnwindSafe for Input<M>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<D> OwoColorize for D
impl<D> OwoColorize for D
source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Set the foreground color generically Read more
source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Set the background color generically. Read more
source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Change the foreground color to black
source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Change the background color to black
source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Change the foreground color to red
source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Change the background color to red
source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Change the foreground color to green
source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Change the background color to green
source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Change the foreground color to yellow
source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Change the background color to yellow
source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Change the foreground color to blue
source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Change the background color to blue
source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Change the foreground color to magenta
source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to magenta
source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Change the foreground color to purple
source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Change the background color to purple
source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Change the foreground color to cyan
source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Change the background color to cyan
source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Change the foreground color to white
source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Change the background color to white
source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Change the foreground color to the terminal default
source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Change the background color to the terminal default
source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Change the foreground color to bright black
source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Change the background color to bright black
source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Change the foreground color to bright red
source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Change the background color to bright red
source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Change the foreground color to bright green
source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Change the background color to bright green
source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Change the foreground color to bright yellow
source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Change the background color to bright yellow
source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Change the foreground color to bright blue
source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Change the background color to bright blue
source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright magenta
source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright magenta
source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Change the foreground color to bright purple
source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Change the background color to bright purple
source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Change the foreground color to bright cyan
source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Change the background color to bright cyan
source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Change the foreground color to bright white
source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Change the background color to bright white
source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Make the text bold
source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Make the text dim
source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Make the text italicized
source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Make the text italicized
source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Make the text blink
source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Make the text blink (but fast!)
source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Swap the foreground and background colors
Hide the text
source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Cross out the text
source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read moresource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read moresource§fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the foreground color to a specific RGB value.
source§fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>
Set the background color to a specific RGB value.
source§fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>
Sets the foreground color to an RGB value.
source§fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>
Sets the background color to an RGB value.