Skip to main content

ConfigReadOptions

qubit_config::options

Struct ConfigReadOptions

pub struct ConfigReadOptions { /* private fields */ }

Expand description

Runtime options that control how configuration values are read and parsed.

Implementations§

impl ConfigReadOptions

pub fn env_friendly() -> Self

Creates options suitable for environment-variable style values.

§Returns

Options that trim strings, treat blank scalar strings as missing, accept common boolean aliases, and split scalar strings on commas while skipping empty collection items. Environment-variable substitution is still disabled; enable it explicitly with Self::with_env_variable_substitution_enabled.

pub fn conversion_options(&self) -> &DataConversionOptions

Gets the underlying data conversion options.

§Returns

Options used by the shared qubit-datatype conversion layer.

pub fn is_env_variable_substitution_enabled(&self) -> bool

Returns whether ${...} substitution may read process environment variables when a value is missing from config.

§Returns

true when environment fallback is enabled.

pub fn with_env_variable_substitution_enabled(self, enabled: bool) -> Self

Returns a copy with environment-variable substitution enabled or disabled.

§Parameters

enabled - Whether unresolved config placeholders may fall back to process environment variables.

§Returns

Updated options.

pub fn with_blank_string_policy(self, policy: BlankStringPolicy) -> Self

Returns a copy with a different blank string policy.

§Parameters

policy - New blank string policy.

§Returns

Updated options.

pub fn with_empty_item_policy(self, policy: EmptyItemPolicy) -> Self

Returns a copy with a different empty collection item policy.

§Parameters

policy - New empty item policy.

§Returns

Updated options.

pub fn with_string_options(self, string: StringConversionOptions) -> Self

Returns a copy with different string conversion options.

§Parameters

string - New string conversion options.

§Returns

Updated options.

pub fn with_boolean_options(self, boolean: BooleanConversionOptions) -> Self

Returns a copy with different boolean conversion options.

§Parameters

boolean - New boolean conversion options.

§Returns

Updated options.

pub fn with_collection_options( self, collection: CollectionConversionOptions, ) -> Self

Returns a copy with different collection conversion options.

§Parameters

collection - New collection conversion options.

§Returns

Updated options.

pub fn with_duration_options(self, duration: DurationConversionOptions) -> Self

Returns a copy with different duration conversion options.

§Parameters

duration - New duration conversion options.

§Returns

Updated options.

Trait Implementations§

impl AsRef<DataConversionOptions> for ConfigReadOptions

fn as_ref(&self) -> &DataConversionOptions

Borrows the underlying data conversion options.

impl Clone for ConfigReadOptions

fn clone(&self) -> ConfigReadOptions

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

impl Debug for ConfigReadOptions

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

Formats the value using the given formatter. Read more

impl Default for ConfigReadOptions

fn default() -> ConfigReadOptions

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

impl<'de> Deserialize<'de> for ConfigReadOptions

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

Deserializes runtime read options.

impl From<DataConversionOptions> for ConfigReadOptions

fn from(conversion: DataConversionOptions) -> Self

Creates config read options from data conversion options.

Environment-variable fallback for ${...} substitution remains disabled.

impl PartialEq for ConfigReadOptions

fn eq(&self, other: &ConfigReadOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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 Serialize for ConfigReadOptions

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

Serializes all runtime read options.

impl Eq for ConfigReadOptions

impl StructuralPartialEq for ConfigReadOptions

Auto Trait Implementations§

impl Freeze for ConfigReadOptions

impl RefUnwindSafe for ConfigReadOptions

impl Send for ConfigReadOptions

impl Sync for ConfigReadOptions

impl Unpin for ConfigReadOptions

impl UnsafeUnpin for ConfigReadOptions

impl UnwindSafe for ConfigReadOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T, D> IntoConfigDefault<T> for D
where D: IntoValueDefault<T>,

fn into_config_default(self) -> T

Converts this fallback value into T.

impl<T> IntoValueDefault<T> for T

fn into_value_default(self) -> T

Converts this argument into the default value.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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