Enum MaybeSecretRef

pub enum MaybeSecretRef {
    String(String),
    SecretRef(String),
}

Enumeration which holds a string or a secret reference which is not yet resolved.

Instantiation is done either directly, using deserialization or by matching a basic string to a particular pattern. Note that the former two allow simple strings to be instantiated that the latter with the pattern would normally map into secret reference.

This class is located in the pipeline-types crate because in future versions it will likely become an object within the API. Deserialization is implemented already for that reason.

Variants

String(String)

SecretRef(String)

Implementations

impl MaybeSecretRef

pub fn new_using_pattern_match(value: String) -> MaybeSecretRef

Determines whether a given string value refers to a secret or is simply a string based on whether it matches the pattern.

A secret must follow the pattern: “${secret:secret-identifier}”

For example for a secret identified by “database-1-user”: “${secret:database-1-user}”

Any string value which does not follow the above pattern is determined to be a simple string.

Note that here is not checked whether the secret identifier can be resolved, nor is specified which requirements the resolver has for the identifier to be valid.

Trait Implementations

impl Clone for MaybeSecretRef

fn clone(&self) -> MaybeSecretRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaybeSecretRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MaybeSecretRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MaybeSecretRef

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

Formats the value using the given formatter.

impl Ord for MaybeSecretRef

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

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

fn partial_cmp(&self, other: &MaybeSecretRef) -> 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<'__s> ToSchema<'__s> for MaybeSecretRef

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for MaybeSecretRef

impl StructuralPartialEq for MaybeSecretRef