Config

Struct Config 

Source
pub struct Config {
    pub current_context: Option<String>,
    pub preferences: Option<Mapping>,
    pub clusters: Vec<Cluster>,
    pub contexts: Vec<Context>,
    pub users: Vec<User>,
    pub api_version: Option<String>,
    pub kind: Option<String>,
}
Expand description

The main struct that holds the entire config map. See the methods on this struct for ways to parse a config.

Fields§

§current_context: Option<String>

The name of the current active context. The actual context can be retrieved by finding the context in the context set based on this name.

§preferences: Option<Mapping>

Preferences provided in the config.yml file.

§clusters: Vec<Cluster>

The clusters as defined by the “clusters” key

§contexts: Vec<Context>

The contexts as defined by the “contexts” key

§users: Vec<User>

The users as defined by the “users” key

§api_version: Option<String>

Will typically be “v1”, generally not needed

§kind: Option<String>

Will typically be “Config”, generally not needed

Implementations§

Source§

impl Config

Source

pub fn load_default() -> Result<Config>

Fetches the current config based on the user’s configured environment.

This includes $KUBECONFIG when set, or simply $HOME/.kube/config otherwise.

TODO: Support multiple kubeconfig files in the KUBECONFIG env var separated by colons, i.e. KUBECONFIG=file1:file2. Merge the result.

Source

pub fn load<P: AsRef<Path>>(path: P) -> Result<Config>

Fetches the config from the provided path.

Source

pub fn get_current_context(&self) -> Option<&Context>

Gets the currently active context based on the current-context key in the config file.

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<'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

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

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, 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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,