Struct cubist_config::secret::SecretUrl

pub struct SecretUrl { /* private fields */ }

A URL that may embed secrets via special interpolation variables.

For example: https://polygon-mumbai.g.alchemy.com/v2/${{env.ALCHEMY_API_KEY}}.

Substrings matching ${{<KIND>.<VALUE>}} (where <KIND> is either env, file, or text, and <VALUE> is an arbitrary string) are subject to interpolation. More precisely:

• if <KIND> is env, <VALUE> is interpreted as environment variable name, and the secret is the value of that environment variable;
• if <KIND> is file, <VALUE> is interpreted as a file name, and the secret is the contents of that file;
• if <KIND> is txt, <VALUE> is interpreted as the secret itself.

See REGEX_STR for the exact regex.

The secret values are loaded only on demand via the Self::load and Self::expose_url methods.

Implementations

impl SecretUrl

pub fn port(&self) -> Option<u16>

Returns the URL port, if any.

pub fn load(&self) -> Result<SecretString>

Loads and embeds any secret values into this URL and returns a secret string.

pub fn scheme(&self) -> &str

Returns the URL scheme

pub fn expose_url(&self) -> Result<Url>

Loads and embeds any secret values into this URL, then converts the result into url::Url.

pub fn expose_url_and_update(
    &self,
    set_scheme: Option<&str>,
    set_port: Option<u16>,
    set_path: Option<&str>
) -> Result<Url>

Loads and embeds any secret values into this URL, then converts the result into url::Url, optionally updating the “scheme”, “port”, and “path” properties of the final URL.

Arguments

• set_scheme - if some, then update the scheme of the exposed URL before returning it
• set_port - if some, then update the port of the exposed URL before returning it
• set_path - if some, then update the path of the exposed URL before returning it

Trait Implementations

impl Clone for SecretUrl

fn clone(&self) -> SecretUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretUrl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretUrl

Same as for url::Url

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

Deserialize this value from the given Serde deserializer.

impl Display for SecretUrl

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

Formats the value using the given formatter.

impl From<Url> for SecretUrl

fn from(url: Url) -> Self

Converts to this type from the input type.

impl JsonSchema for SecretUrl

Same as for url::Url

fn schema_name() -> String

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for SecretUrl

Same as for url::Url

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

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for SecretUrl

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.