Struct parol::generators::naming_helper::NamingHelper

source · [−]

pub struct NamingHelper;

Expand description

Struct used as namespace only

Implementations

source

impl NamingHelper

source

pub fn is_rust_keyword(name: &str) -> bool

Checks whether the given name is a reserved Rust keyword

use parol::generators::NamingHelper as NmHlp;
assert!(!NmHlp::is_rust_keyword("Type"));
assert!(NmHlp::is_rust_keyword("type"));

source

pub fn is_raw_identifier(name: &str) -> bool

Checks whether the symbol starts with “r#”

use parol::generators::naming_helper::NamingHelper;

assert!(NamingHelper::is_raw_identifier("r#let"));
assert!(!NamingHelper::is_raw_identifier("_let"));

source

pub fn escape_rust_keyword(name: String) -> String

If the given name is a reserved Rust keyword it is converted into a raw identifier

use parol::generators::NamingHelper as NmHlp;
assert_eq!("Type".to_string(), NmHlp::escape_rust_keyword("Type".to_string()));
assert_eq!("r#type".to_string(), NmHlp::escape_rust_keyword("type".to_string()));

source

pub fn item_unused_indicator(used: bool) -> &'static str

Returns an underscore string if the item is not used.

source

pub fn add_unused_indicator(used: bool, name: &str) -> String

Returns an underscore string if the item is not used.

use parol::generators::naming_helper::NamingHelper;

assert_eq!(NamingHelper::add_unused_indicator(false, "r#let"), "_let");
assert_eq!(NamingHelper::add_unused_indicator(false, "x"), "_x");
assert_eq!(NamingHelper::add_unused_indicator(true, "x"), "x");

source

pub fn to_lower_snake_case(name: &str) -> String

Produces a lower snake camel case version of the given name. Since these names are supposed to be used as identifiers a clash with rust keywords is detected and prevented.

use parol::generators::NamingHelper as NmHlp;
assert_eq!("prolog0", NmHlp::to_lower_snake_case("Prolog0"));
assert_eq!("_prolog_0_", NmHlp::to_lower_snake_case("_prolog_0_"));
assert_eq!("_prolog_0_1_3", NmHlp::to_lower_snake_case("_prolog_0_1__3"));
assert_eq!("_", NmHlp::to_lower_snake_case("_____"));
assert_eq!("calc_lst1_1", NmHlp::to_lower_snake_case("calc_lst1_1"));
assert_eq!("nor_op_23", NmHlp::to_lower_snake_case("nor_op_23"));
assert_eq!("r#type", NmHlp::to_lower_snake_case("type"));

source

pub fn to_upper_camel_case(name: &str) -> String

Produces an upper camel case version of the given name. Separated numbers are kept separated. Camel case compliant input should be preserved.

use parol::generators::NamingHelper as NmHlp;
assert_eq!("Prolog0", NmHlp::to_upper_camel_case("_prolog_0"));
assert_eq!("Prolog0", NmHlp::to_upper_camel_case("_prolog_0_"));
assert_eq!("Prolog0", NmHlp::to_upper_camel_case("_prolog_0__"));
assert_eq!("Prolog0_1", NmHlp::to_upper_camel_case("_prolog_0__1"));
assert_eq!("Prolog0_1_10_20", NmHlp::to_upper_camel_case("_prolog_0__1_10___20__"));
assert_eq!("Prolog0A", NmHlp::to_upper_camel_case("_prolog_0__a"));
assert_eq!("PrologAA", NmHlp::to_upper_camel_case("_prolog_a_a"));
assert_eq!("PrologItem", NmHlp::to_upper_camel_case("prolog_item"));
assert_eq!("PrologItem", NmHlp::to_upper_camel_case("PrologItem"));
assert_eq!("AA", NmHlp::to_upper_camel_case("_a_a_"));

source

pub fn is_valid_name_character(c: char) -> bool

This is a very restrictive definition of allowed characters in identifiers parol allows. Invalid characters in terminal names, non-terminal names and module names are typically replaced by the underscore character and can later be removed during name generations using special casing rules like UpperCamelCase.

use parol::generators::naming_helper::NamingHelper;

assert!(NamingHelper::is_valid_name_character('a'));
assert!(NamingHelper::is_valid_name_character('A'));
assert!(NamingHelper::is_valid_name_character('1'));
assert!(NamingHelper::is_valid_name_character('_'));

assert!(!NamingHelper::is_valid_name_character('-'));
assert!(!NamingHelper::is_valid_name_character(':'));
assert!(!NamingHelper::is_valid_name_character('/'));

source

pub fn purge_name(name: &str) -> String

Replaces all invalid characters from the given name with underscores. It is used to process user given names which are for instance given as command arguments.

Examples

use parol::generators::naming_helper::NamingHelper;

assert_eq!(NamingHelper::purge_name("test-module"), "test_module");

Auto Trait Implementations

impl RefUnwindSafe for NamingHelper

impl Send for NamingHelper

impl Sync for NamingHelper

impl Unpin for NamingHelper

impl UnwindSafe for NamingHelper

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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<D> OwoColorize for D

source

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,

Set the background color generically. Read more

source

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

source

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

source

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

source

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

source

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

source

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

source

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

source

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

source

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

source

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

source

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

source

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

source

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

source

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

source

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

source

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

source

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

source

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

source

fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

source

fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

source

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

source

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

source

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

source

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

source

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

source

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

source

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

source

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

source

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

source

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

source

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

source

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

source

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

source

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

source

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

source

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

source

fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

source

fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

source

fn bold(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

source

fn dimmed(&'a self) -> DimDisplay<'a, Self>

Make the text dim

source

fn italic(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

source

fn underline(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

source

fn blink(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

source

fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

source

fn reversed(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

source

fn hidden(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

source

fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

source

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 more

source

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 more

source

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>

Set the background color to a specific RGB value.

source

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>

Sets the background color to an RGB value.

source

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct parol::generators::naming_helper::NamingHelper

Implementations

impl NamingHelper

pub fn is_rust_keyword(name: &str) -> bool

pub fn is_raw_identifier(name: &str) -> bool

pub fn escape_rust_keyword(name: String) -> String

pub fn item_unused_indicator(used: bool) -> &'static str

pub fn add_unused_indicator(used: bool, name: &str) -> String

pub fn to_lower_snake_case(name: &str) -> String

pub fn to_upper_camel_case(name: &str) -> String

pub fn is_valid_name_character(c: char) -> bool

pub fn purge_name(name: &str) -> String

Examples

Auto Trait Implementations

impl RefUnwindSafe for NamingHelper

impl Send for NamingHelper

impl Sync for NamingHelper

impl Unpin for NamingHelper

impl UnwindSafe for NamingHelper

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where C: Color,

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>

fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

fn bold(&'a self) -> BoldDisplay<'a, Self>

fn dimmed(&'a self) -> DimDisplay<'a, Self>

fn italic(&'a self) -> ItalicDisplay<'a, Self>

fn underline(&'a self) -> UnderlineDisplay<'a, Self>

fn blink(&'a self) -> BlinkDisplay<'a, Self>

fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>

fn reversed(&'a self) -> ReversedDisplay<'a, Self>

fn hidden(&'a self) -> HiddenDisplay<'a, Self>

fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self> where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self> where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self> where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,