Struct naga::proc::Namer

source ·
pub struct Namer {
    unique: FastHashMap<String, u32>,
    keywords: FastHashSet<&'static str>,
    keywords_case_insensitive: FastHashSet<AsciiUniCase<&'static str>>,
    reserved_prefixes: Vec<&'static str>,
}
Expand description

This processor assigns names to all the things in a module that may need identifiers in a textual backend.

Fields§

§unique: FastHashMap<String, u32>

The last numeric suffix used for each base name. Zero means “no suffix”.

§keywords: FastHashSet<&'static str>§keywords_case_insensitive: FastHashSet<AsciiUniCase<&'static str>>§reserved_prefixes: Vec<&'static str>

Implementations§

source§

impl Namer

source

fn sanitize<'s>(&self, string: &'s str) -> Cow<'s, str>

Return a form of string suitable for use as the base of an identifier.

  • Drop leading digits.
  • Retain only alphanumeric and _ characters.
  • Avoid prefixes in Namer::reserved_prefixes.
  • Replace consecutive _ characters with a single _ character.

The return value is a valid identifier prefix in all of Naga’s output languages, and it never ends with a SEPARATOR character. It is used as a key into the unique table.

source

pub fn call(&mut self, label_raw: &str) -> String

Return a new identifier based on label_raw.

The result:

  • is a valid identifier even if label_raw is not
  • conflicts with no keywords listed in Namer::keywords, and
  • is different from any identifier previously constructed by this Namer.

Guarantee uniqueness by applying a numeric suffix when necessary. If label_raw itself ends with digits, separate them from the suffix with an underscore.

source

pub fn call_or(&mut self, label: &Option<String>, fallback: &str) -> String

source

fn namespace(&mut self, capacity: usize, body: impl FnOnce(&mut Self))

Enter a local namespace for things like structs.

Struct member names only need to be unique amongst themselves, not globally. This function temporarily establishes a fresh, empty naming context for the duration of the call to body.

source

pub fn reset( &mut self, module: &Module, reserved_keywords: &[&'static str], extra_reserved_keywords: &[&'static str], reserved_keywords_case_insensitive: &[&'static str], reserved_prefixes: &[&'static str], output: &mut FastHashMap<NameKey, String>, )

Trait Implementations§

source§

impl Default for Namer

source§

fn default() -> Namer

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

Auto Trait Implementations§

§

impl Freeze for Namer

§

impl RefUnwindSafe for Namer

§

impl Send for Namer

§

impl Sync for Namer

§

impl Unpin for Namer

§

impl UnwindSafe for Namer

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.