Struct async_graphql_parser::types::Name

pub struct Name(_);

A GraphQL name. This is a newtype wrapper around a string with the addition guarantee that it is a valid GraphQL name (follows the regex [_A-Za-z][_0-9A-Za-z]*).

Reference.

Implementations

impl Name

#[must_use]pub fn is_valid(name: &str) -> bool

Check whether the name is valid (follows the regex [_A-Za-z][_0-9A-Za-z]*).

#[must_use]pub fn new_unchecked(name: String) -> Self

Create a new name without checking whether it is valid or not. This will always check in debug mode.

This function is not unsafe because an invalid name does not cause UB, but care should be taken to make sure it is a valid name.

pub fn new(name: String) -> Result<Self, String>

Create a new name, checking whether it is valid. Returns ownership of the string if it fails.

Errors

Fails if the name is not a valid name.

#[must_use]pub fn as_str(&self) -> &str

Get the name as a string.

#[must_use]pub fn into_string(self) -> String

Convert the name to a String.

Trait Implementations

impl AsRef<str> for Name

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for Name

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Deref for Name

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Name

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Name

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

Formats the value using the given formatter.

impl Eq for Name

impl From<Name> for String

fn from(name: Name) -> Self

Performs the conversion.

impl Hash for Name

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 Ord for Name

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> PartialEq<&'a str> for Name

fn eq(&self, other: &&'a str) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Name> for Name

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

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

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

This method tests for !=.

impl PartialEq<Name> for String

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Name> for str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Name> for &'a str

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<String> for Name

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<str> for Name

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Name> for Name

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Name

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Name

impl StructuralPartialEq for Name