Struct Credential 

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

A wrapper around the blake2b-224 hash digest of a key or script.

It behaves like a enum with two variants, although the constructors are kept private to avoid leaking implementation internals. One can manipulate either of the two variants by using the higher-level API:

• Self::as_key
• Self::as_script

If something more fine-grained is needed where either are needed, one may simply use:

• Self::select

Implementations

impl Credential

pub const DIGEST_SIZE: usize = 28

pub fn from_key(hash: Hash<28>) -> Self

Construct a credential from a key.

See also key_credential!.

pub fn from_script(hash: Hash<28>) -> Self

Construct a credential from a script.

See also script_credential!.

impl Credential

pub fn select<T>( &self, when_key: impl FnMut(Hash<28>) -> T, when_script: impl FnMut(Hash<28>) -> T, ) -> T

Run a computation (possibly the same) for either of the two variants.

examples

assert_eq!(
  script_credential!("bd3ae991b5aafccafe5ca70758bd36a9b2f872f57f6d3a1ffa0eb777")
    .select(
        |_| "is_key".to_string(),
        |_| "is_script".to_string(),
    ),
  "is_script"
);

assert_eq!(
  key_credential!("bd3ae991b5aafccafe5ca70758bd36a9b2f872f57f6d3a1ffa0eb777")
    .select(
        |hash| format!("Key({hash})"),
        |hash| format!("Script({hash})"),
    ),
  "Key(bd3ae991b5aafccafe5ca70758bd36a9b2f872f57f6d3a1ffa0eb777)"
)

pub fn as_key(&self) -> Option<Hash<28>>

Continues with the inner hash, provided that the credential is that of a key.

pub fn as_script(&self) -> Option<Hash<28>>

Continues with the inner hash, provided that the credential is that of a script.

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl<'bytes, Ctx> Decode<'bytes, Ctx> for Credential

fn decode( __d777: &mut Decoder<'bytes>, __ctx777: &mut Ctx, ) -> Result<Credential, Error>

Decode a value using the given Decoder.

fn nil() -> Option<Self>

If possible, return a nil value of Self.

impl Default for Credential

fn default() -> Self

Returns the “default value” for a type.

impl Display for Credential

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

Formats the value using the given formatter.

impl<Ctx> Encode<Ctx> for Credential

fn encode<__W777>( &self, __e777: &mut Encoder<__W777>, __ctx777: &mut Ctx, ) -> Result<(), Error<__W777::Error>>

where __W777: Write,

Encode a value of this type using the given Encoder.

fn is_nil(&self) -> bool

Is this value of Self a nil value?

impl From<&Credential> for [u8; 28]

fn from(credential: &Credential) -> Self

Converts to this type from the input type.

impl From<&Credential> for Hash<28>

fn from(credential: &Credential) -> Self

Converts to this type from the input type.

impl From<&ShelleyPaymentPart> for Credential

fn from(payment_part: &ShelleyPaymentPart) -> Self

Converts to this type from the input type.

impl From<&StakePayload> for Credential

fn from(stake_payload: &StakePayload) -> Self

Converts to this type from the input type.

impl From<&VerificationKey> for Credential

fn from(key: &VerificationKey) -> Self

Converts to this type from the input type.

impl From<Credential> for ShelleyDelegationPart

fn from(credential: Credential) -> Self

Converts to this type from the input type.

impl From<Credential> for ShelleyPaymentPart

fn from(credential: Credential) -> Self

Converts to this type from the input type.

impl From<Credential> for StakeCredential

fn from(credential: Credential) -> Self

Converts to this type from the input type.

impl From<StakeCredential> for Credential

fn from(credential: StakeCredential) -> Self

Converts to this type from the input type.

impl FromStr for Credential

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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

impl Ord for Credential

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

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

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(delegation_part: &ShelleyDelegationPart) -> Result<Self>

Performs the conversion.

impl Eq for Credential

impl StructuralPartialEq for Credential