Skip to main content

StringConversionOptions

Struct StringConversionOptions 

Source
pub struct StringConversionOptions {
    pub trim: bool,
    pub blank_string_policy: BlankStringPolicy,
}
Expand description

Controls normalization applied once before parsing a string source.

Trimming happens before blank detection. A value is considered blank when it consists only of Unicode whitespace, even when trim is disabled; BlankStringPolicy::Preserve returns the original untrimmed slice in that case.

§Examples

use qubit_datatype::StringConversionOptions;

let options = StringConversionOptions::env_friendly();
assert_eq!(options.normalize("  value  "), Ok("value"));
assert!(options.normalize("   ").is_err());

Fields§

§trim: bool

Whether strings are trimmed before conversion.

§blank_string_policy: BlankStringPolicy

How blank strings are interpreted after optional trimming.

Implementations§

Source§

impl StringConversionOptions

Source

pub const fn env_friendly() -> Self

Creates options suitable for environment-variable input.

The profile trims surrounding whitespace and treats a blank value as missing, matching common environment configuration conventions.

§Returns

Environment-friendly string normalization options.

Source

pub fn with_trim(self, trim: bool) -> Self

Returns a copy with string trimming enabled or disabled.

§Parameters
  • trim - Whether strings should be trimmed.
§Returns

Updated options.

Source

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.

Source

pub fn normalize<'a>( &self, value: &'a str, ) -> Result<&'a str, StringNormalizationError>

Normalizes a string source according to these options.

§Parameters
  • value - Source string.
§Returns

Returns the normalized string.

§Errors

Returns StringNormalizationError::Missing when blank strings are treated as missing, or StringNormalizationError::BlankRejected when blank strings are rejected.

Trait Implementations§

Source§

impl Clone for StringConversionOptions

Source§

fn clone(&self) -> StringConversionOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StringConversionOptions

Source§

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

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

impl Default for StringConversionOptions

Source§

fn default() -> Self

Creates default string conversion options.

Source§

impl<'de> Deserialize<'de> for StringConversionOptions

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 Eq for StringConversionOptions

Source§

impl PartialEq for StringConversionOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for StringConversionOptions

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
Source§

impl StructuralPartialEq for StringConversionOptions

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

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.