Enum NatsCredentials 

pub enum NatsCredentials {
    None,
    Jwt(NatsJwtCredentials),
    UserAndPassword {
        user: String,
        password: String,
    },
}

Information required to authenticate against NATS server

Variants

None

connect anonymously

Jwt(NatsJwtCredentials)

Authenticate via JWT and private key

UserAndPassword

Authenticate via username and plaintext password.

Fields

user: String

username

password: String

plaintext password

Implementations

impl NatsCredentials

const AUTH_TYPE: &'static str = "NATS_AUTH_TYPE"

name of the auth type environment variable

const AUTH_TOKEN: &'static str = "NATS_AUTH_TOKEN"

name of the auth token environment variable

const AUTH_KEY: &'static str = "NATS_AUTH_KEY"

name of the auth key environment variable.

pub fn from_env() -> Result<Self, ArminiusConfigurationError>

Attempts to parse NatsCredentials from environment vars.

The following env vars are taken into account:

• NATS_AUTH_TYPE : the authentication mechanism to use.
  • If not set, NatsCredentials::None is returned.
  • if set to JWT, the following vars need to be given:
    • NATS_AUTH_TOKEN a JWT token denoting a user
    • NATS_AUTH_KEY a Signing Key that is used to sign server nonces

As of now, only JWT is supported. If the var is not set, NatsCredentials::None is returned.

fn parse_from_env(env: &impl Env) -> Result<Self, ArminiusConfigurationError>

Attempts to parse Credentials from the given environment. Currently, this only supports credentials of the type NatsCredentials::Jwt.

fn parse_jwt_credentials( env: &impl Env, ) -> Result<Self, ArminiusConfigurationError>

Attempts to parse a NatsCredentials::Jwt from the given environment.

fn get_env_var( env: &impl Env, var: &'static str, ) -> Result<String, ArminiusConfigurationError>

Retrieves an environment variable, translating the error to a ArminiusConfigurationError

Trait Implementations

impl Clone for NatsCredentials

fn clone(&self) -> NatsCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NatsCredentials

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

Formats the value using the given formatter.

impl From<NatsCredentials> for ConnectOptions

fn from(val: NatsCredentials) -> Self

Converts to this type from the input type.

impl From<NatsJwtCredentials> for NatsCredentials

fn from(value: NatsJwtCredentials) -> Self

Converts to this type from the input type.