Struct idioma::Text

pub struct Text { /* fields omitted */ }

Text is the main type that gets thrown around between functions and methods. It is basically a String, but it had to be made into a separate struct so that it would be possible to impl some things for it.

Implementations

impl Text

pub fn make<I>(label: ColoredString, message: I) -> Self where
    I: Display, 

Returns Text by constructing it from a given label and message.

Examples

use idioma::*;
use colored::*;
Text::make("lol".cyan().bold(), "LMAO you're so funny.");

pub fn print(&self)

Displays Text thanks to the std::fmt::Display trait.

Examples

use idioma::*;
warning("This message is going to be printed out immediately!").print();

pub fn exit(self, code: i32) -> Self

Displays message and terminates the program via std::process::exit. Please note that this function returns Text back in case we need to please the type checker. See exit_if_error function for an example of that.

Examples

use idioma::*;
error("You were not supposed to mess with me!").exit(1);

You can even combine custom and exit to produce some real nice stuff.

use idioma::*;
use colored::*;
custom("lol".cyan().bold())("Did you expect something serious here? LMAO XD").exit(1);

Trait Implementations

impl Debug for Text

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

Formats the value using the given formatter.

impl Display for Text

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

Formats the value using the given formatter.