Struct GithubHandle 

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

Available on crate feature github only.

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 CursorType for GithubHandle

Available on crate feature async-graphql only.

type Error = ParseHandleError

Error type for decode_cursor.

fn decode_cursor( input: &str, ) -> Result<GithubHandle, <GithubHandle as CursorType>::Error>

Decode cursor from string.

fn encode_cursor(&self) -> String

Encode cursor to string.

impl Debug for GithubHandle

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

Formats the value using the given formatter.

impl<'r, DB> Decode<'r, DB> for GithubHandle

where DB: Database, String: Decode<'r, DB>,

Available on crate feature sqlx only.

fn decode( value: <DB as Database>::ValueRef<'r>, ) -> Result<GithubHandle, Box<dyn Error + Send + Sync>>

Decode a new value of this type using a raw value from the database.

impl<'de> Deserialize<'de> for GithubHandle

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GithubHandle

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

Formats the value using the given formatter.

impl<'q, DB> Encode<'q, DB> for GithubHandle

where DB: Database, String: Encode<'q, DB>,

Available on crate feature sqlx only.

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

Writes the value of self into buf without moving self.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Send + Sync>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

impl Eq for GithubHandle

impl From<GithubHandle> for SocialHandle

fn from(value: GithubHandle) -> Self

Converts to this type from the input type.

impl FromStr for GithubHandle

type Err = ParseHandleError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<GithubHandle, <GithubHandle as FromStr>::Err>

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

impl Hash for GithubHandle

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

where H: Hasher,

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 InputType for GithubHandle

type RawValueType = GithubHandle

The raw type used for validator.

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

fn parse( value: Option<ConstValue>, ) -> Result<GithubHandle, InputValueError<GithubHandle>>

Parse from Value. None represents undefined.

fn to_value(&self) -> ConstValue

Convert to a Value for introspection.

fn as_raw_value(&self) -> Option<&<GithubHandle as InputType>::RawValueType>

Returns a reference to the raw value.

fn qualified_type_name() -> String

Qualified typename.

impl Ord for GithubHandle

fn cmp(&self, other: &GithubHandle) -> 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 OutputType for GithubHandle

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

async fn resolve( &self, _: &ContextBase<'_, &Positioned<SelectionSet>>, _field: &Positioned<Field>, ) -> Result<ConstValue, ServerError>

Available on non-crate feature boxed-trait only.

Resolve an output value to async_graphql::Value.

fn qualified_type_name() -> String

Qualified typename.

fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name

impl PartialEq for GithubHandle

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for GithubHandle

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

fn parse( value: ConstValue, ) -> Result<GithubHandle, InputValueError<GithubHandle>>

Parse a scalar value.

fn is_valid(value: &ConstValue) -> bool

Checks for a valid scalar value.

fn to_value(&self) -> ConstValue

Convert the scalar to Value.

impl Serialize for GithubHandle

Available on crate feature serde only.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for GithubHandle

type Error = ParseHandleError

The type returned in the event of a conversion error.

fn try_from( input: &str, ) -> Result<GithubHandle, <GithubHandle as TryFrom<&str>>::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<GithubHandle, <GithubHandle as TryFrom<String>>::Error>

Performs the conversion.

impl<DB> Type<DB> for GithubHandle

where DB: Database, String: Type<DB>,

Available on crate feature sqlx only.

fn type_info() -> <DB as Database>::TypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.