Skip to main content

ParameterValue

Struct ParameterValue 

Source
pub struct ParameterValue { /* private fields */ }
Expand description

Value of a parameter with typed conversion methods.

Implementations§

Source§

impl ParameterValue

Source

pub fn new(data: String, level: usize) -> Self

Creates a new parameter value.

Source

pub fn as_str(&self) -> &str

Gets the raw string value.

Source

pub fn as_string_or(&self, default: &str) -> String

Gets the string value, or a default if empty.

Source

pub fn as_int(&self) -> Result<i32, ParseIntError>

Parses the value as an integer.

Source

pub fn as_int_or(&self, default: i32) -> i32

Gets the value as an integer, or a default on parse failure.

Source

pub fn as_double(&self) -> Result<f64, ParseFloatError>

Parses the value as a double.

Source

pub fn as_double_or(&self, default: f64) -> f64

Gets the value as a double, or a default on parse failure.

Source

pub fn as_bool(&self) -> Result<bool, &'static str>

Parses the value as a boolean.

Accepts: “T”, “TRUE” (true), “F”, “FALSE” (false)

Source

pub fn as_bool_or(&self, default: bool) -> bool

Gets the value as a boolean, or a default on parse failure.

Source

pub fn as_coord(&self) -> Result<Coord, AltiumError>

Parses the value as a Coord using unit suffix.

Source

pub fn as_coord_or(&self, default: Coord) -> Coord

Gets the value as a Coord, or a default on parse failure.

Source

pub fn as_color(&self) -> Result<Color, ParseIntError>

Parses the value as a Color (Win32 COLORREF).

Source

pub fn as_color_or(&self, default: Color) -> Color

Gets the value as a Color, or a default on parse failure.

Source

pub fn as_layer(&self) -> Layer

Parses the value as a Layer.

Source

pub fn as_parameters(&self) -> ParameterCollection

Parses the value as a nested ParameterCollection.

Source

pub fn as_string_list(&self) -> Vec<String>

Splits the value by the list separator and returns string items.

Source

pub fn as_int_list(&self) -> Vec<i32>

Splits the value by the list separator and returns integer items.

Source

pub fn as_double_list(&self) -> Vec<f64>

Splits the value by the list separator and returns double items.

Source

pub fn as_coord_list(&self) -> Vec<Coord>

Splits the value by the list separator and returns Coord items.

Source

pub fn is_parameters(&self) -> bool

Returns true if this value contains nested parameters.

Source

pub fn is_list(&self) -> bool

Returns true if this value is a list (contains commas).

Trait Implementations§

Source§

impl Clone for ParameterValue

Source§

fn clone(&self) -> ParameterValue

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 ParameterValue

Source§

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

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

impl Default for ParameterValue

Source§

fn default() -> ParameterValue

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

impl Display for ParameterValue

Source§

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

Formats the value using the given formatter. 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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool