Struct CredentialName 

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

The name of an environment variable a credential arrives under.

A newtype rather than a String because the domain is real and narrow — what a shell could have exported — and a report naming something outside it would be reporting a credential that no layer could ever resolve. CredentialName::new is the only way to make one, so that report cannot be built.

Implementations

impl CredentialName

pub fn new(name: &str) -> Option<Self>

name when a shell could have exported it, and nothing otherwise.

pub fn as_str(&self) -> &str

The name itself.

Trait Implementations

impl Borrow<str> for CredentialName

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for CredentialName

fn clone(&self) -> CredentialName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CredentialName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CredentialName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CredentialName

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

Through pad, so a {:width$} of one lines a column of these up. write_str would silently ignore the width, which is how the report’s column stops aligning.

impl Eq for CredentialName

impl From<CredentialName> for String

fn from(value: CredentialName) -> Self

Converts to this type from the input type.

impl Hash for CredentialName

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 JsonSchema for CredentialName

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for CredentialName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CredentialName

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CredentialName

impl TryFrom<String> for CredentialName

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

Read a name a shell could have exported, and refuse anything else where it is written.

This is what lets a configuration field hold the type rather than a String it checks later: a name no layer could ever resolve stops being representable at all, instead of surfacing as a credential mysteriously reported absent.

type Error = String

The type returned in the event of a conversion error.