Struct mininip::datas::Identifier

pub struct Identifier { /* fields omitted */ }

The identifier of a variable, which is its identity. Of course, this type is Hash because it may be used as a key in a HashMap

Methods

impl Identifier

pub fn new(section: Option<String>, name: String) -> Identifier

Creates an identifier with a valid section name and a valid name

Panics

Panics if either section or name is an invalid identifier according to Identifier::is_valid

pub fn is_valid(ident: &str) -> bool

Returns true if the given string is a valid identifier and false otherwise

A valid identifier is defined as a string of latin alphanumeric characters and any of _, ~, -, ., :, $ and space starting with a latin alphabetic one or any of ., $ or :. All of these characters must be ASCII

Notes

Since the INI file format is not really normalized, this definition may evolve in the future. In fact, I will avoid when possible to make a stronger rule, in order to keep backward compatibility

Examples

use mininip::datas::Identifier;
 
assert!(Identifier::is_valid("identifier"));
assert!(Identifier::is_valid("digits1230"));
assert!(Identifier::is_valid("UPPERCASE_AND_UNDERSCORES"));
assert!(Identifier::is_valid("contains spaces inside"));
assert!(!Identifier::is_valid("123_starts_with_a_digit"));
assert!(!Identifier::is_valid("invalid_characters;!\\~"));
assert!(!Identifier::is_valid("é_is_unicode"));
assert!(!Identifier::is_valid(" starts_with_a_space"));

pub fn name(&self) -> &str

Returns the name of the variable as a reference

pub fn section(&self) -> Option<&str>

Returns the section of the variable which may be a named section as Some(name) or the "global scope" wich is None

pub fn change_name(&mut self, name: String)

Change the name of the variable

Panics

Panics if name is invalid according to Identifier::is_valid

pub fn change_section(&mut self, section: Option<String>)

Changes the section of the variable. section may be Some(name) with name as the name of the section of None for the "global scope"

Panics

Panics if section is invalid according to Identifier::is_valid

Trait Implementations

impl Clone for Identifier

fn clone(&self) -> Identifier

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Identifier

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

Formats the value using the given formatter.

impl Display for Identifier

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

Formats the value using the given formatter.

impl Eq for Identifier

impl Hash for Identifier

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Identifier> for Identifier

fn eq(&self, other: &Identifier) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Identifier) -> bool

This method tests for !=.

impl StructuralEq for Identifier

impl StructuralPartialEq for Identifier