Struct GoIdentifier 

pub struct GoIdentifier(/* private fields */);

Validated ASCII-safe Go identifier.

Implementations

impl GoIdentifier

pub fn new(value: impl Into<String>) -> Result<Self, GoIdentifierError>

Creates an ASCII-safe Go identifier.

Errors

Returns GoIdentifierError when value is empty or not ASCII identifier-shaped.

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), use_go_identifier::GoIdentifierError> {
    let identifier = GoIdentifier::new("ServeHTTP")?;
    let exported = GoExportedIdentifier::new("ServeHTTP")?;

    assert_eq!(identifier.as_str(), "ServeHTTP");
    assert_eq!(exported.as_str(), "ServeHTTP");
    assert!(is_unexported_go_identifier("_internal"));
    Ok(())
}

pub fn as_str(&self) -> &str

Returns the identifier as a string slice.

Examples found in repository

examples/basic_usage.rs (line 7)

fn main() -> Result<(), use_go_identifier::GoIdentifierError> {
    let identifier = GoIdentifier::new("ServeHTTP")?;
    let exported = GoExportedIdentifier::new("ServeHTTP")?;

    assert_eq!(identifier.as_str(), "ServeHTTP");
    assert_eq!(exported.as_str(), "ServeHTTP");
    assert!(is_unexported_go_identifier("_internal"));
    Ok(())
}

pub fn into_string(self) -> String

Consumes the identifier and returns the owned text.

pub fn is_exported(&self) -> bool

Returns whether this identifier is exported by ASCII convention.

pub fn is_unexported(&self) -> bool

Returns whether this identifier is unexported by ASCII convention.

Trait Implementations

impl AsRef<str> for GoIdentifier

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for GoIdentifier

fn clone(&self) -> GoIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoIdentifier

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

Formats the value using the given formatter.

impl Display for GoIdentifier

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

Formats the value using the given formatter.

impl FromStr for GoIdentifier

type Err = GoIdentifierError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for GoIdentifier

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GoIdentifier

fn cmp(&self, other: &GoIdentifier) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GoIdentifier

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GoIdentifier

fn partial_cmp(&self, other: &GoIdentifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for GoIdentifier

type Error = GoIdentifierError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for GoIdentifier

impl StructuralPartialEq for GoIdentifier