Struct GithubHandle 

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

A GitHub handle (aka username).

Contains 1–39 ASCII letters, digits, or single interior hyphens. Enterprise Managed Users may additionally have an _ followed by a 3–8 character alphanumeric enterprise shortcode. GitHub’s current and legacy-compatible ceiling is 39 characters (30 for some data-residency managed users). Parsing drops one optional @ and preserves spelling; equality, ordering, and hashing ignore ASCII case.

See https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/iam-configuration-reference/username-considerations-for-external-authentication.

use known_types_github::GithubHandle;

let managed: GithubHandle = "@The-Octocat_octo".parse()?;
assert_eq!(managed.as_str(), "The-Octocat_octo");
assert!("octo--cat".parse::<GithubHandle>().is_err());

See the shared handle contract for conversion and integration behavior. With async-graphql, the scalar is named GithubHandle.

Implementations

impl GithubHandle

pub const MIN_LENGTH: usize = 1

Minimum length of the normalized handle, in Unicode scalar values.

pub const MAX_LENGTH: usize = 39

Maximum representational length, in Unicode scalar values.

This is the widest known current or historical upstream bound, not necessarily the current registration limit.

pub fn as_str(&self) -> &str

Borrow the validated, normalized handle.

pub fn into_string(self) -> String

Consume the handle and return its stored spelling.

Trait Implementations

impl AsRef<String> for GithubHandle

fn as_ref(&self) -> &String

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

impl AsRef<str> for GithubHandle

fn as_ref(&self) -> &str

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

impl Clone for GithubHandle

fn clone(&self) -> GithubHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GithubHandle

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

Formats the value using the given formatter.

impl Display for GithubHandle

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

Formats the value using the given formatter.

impl Eq for GithubHandle

impl FromStr for GithubHandle

type Err = ParseHandleError

The associated error which can be returned from parsing.

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

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

impl Hash for GithubHandle

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 GithubHandle

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for GithubHandle

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GithubHandle

fn partial_cmp(&self, other: &Self) -> 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 GithubHandle

type Error = ParseHandleError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for GithubHandle

type Error = ParseHandleError

The type returned in the event of a conversion error.

fn try_from(input: String) -> Result<Self, Self::Error>

Performs the conversion.