Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub default_enterprise: Option<String>,
    pub default_cloud: Option<String>,
    pub default_database: Option<String>,
    pub files_api_key: Option<String>,
    pub profiles: HashMap<String, Profile>,
}
Expand description

Main configuration structure

Fields§

§default_enterprise: Option<String>

Default profile for enterprise commands

§default_cloud: Option<String>

Default profile for cloud commands

§default_database: Option<String>

Default profile for database commands

§files_api_key: Option<String>

Global Files.com API key for support package uploads Can be overridden per-profile. Supports keyring: prefix for secure storage.

§profiles: HashMap<String, Profile>

Map of profile name -> profile configuration

Implementations§

Source§

impl Config

Source

pub fn find_first_profile_of_type( &self, deployment_type: DeploymentType, ) -> Option<&str>

Get the first profile of the specified deployment type (sorted alphabetically by name)

Source

pub fn get_profiles_of_type(&self, deployment_type: DeploymentType) -> Vec<&str>

Get all profiles of the specified deployment type

Source

pub fn resolve_enterprise_profile( &self, explicit_profile: Option<&str>, ) -> Result<String>

Resolve the profile to use for enterprise commands

Source

pub fn resolve_cloud_profile( &self, explicit_profile: Option<&str>, ) -> Result<String>

Resolve the profile to use for cloud commands

Source

pub fn resolve_database_profile( &self, explicit_profile: Option<&str>, ) -> Result<String>

Resolve the profile to use for database commands

Source

pub fn resolve_profile_deployment( &self, explicit_profile: Option<&str>, ) -> Result<DeploymentType>

Resolve the deployment type from the active profile context.

Used by the arg-rewriting layer to infer whether a shared command (e.g. database, user, acl) should be routed to Cloud or Enterprise.

Resolution order:

  1. If explicit_profile is given, look it up and return its deployment_type
  2. If only cloud profiles exist, return Cloud
  3. If only enterprise profiles exist, return Enterprise
  4. If both exist, return Err(AmbiguousDeployment) with guidance
  5. If neither exists, return Err(NoProfilesOfType)
Source

pub fn load() -> Result<Self>

Load configuration from the standard location

Source

pub fn load_from_path(config_path: &Path) -> Result<Self>

Load configuration from a specific path

Source

pub fn save(&self) -> Result<()>

Save configuration to the standard location

Source

pub fn save_to_path(&self, config_path: &Path) -> Result<()>

Save configuration to a specific path

Source

pub fn set_profile(&mut self, name: String, profile: Profile)

Set or update a profile

Source

pub fn remove_profile(&mut self, name: &str) -> Option<Profile>

Remove a profile by name

Source

pub fn list_profiles(&self) -> Vec<(&String, &Profile)>

List all profiles sorted by name

Source

pub fn config_path() -> Result<PathBuf>

Get the path to the configuration file

On macOS, this supports both the standard macOS path and Linux-style ~/.config path:

  1. Check ~/.config/redisctl/config.toml (Linux-style, preferred for consistency)
  2. Fall back to ~/Library/Application Support/com.redis.redisctl/config.toml (macOS standard)

On Linux: ~/.config/redisctl/config.toml On Windows: %APPDATA%\redis\redisctl\config.toml

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Config

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Config

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Config

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,