pub enum TypedParameter {
Show 25 variants
Int {
default: Option<i32>,
},
Float {
default: Option<f32>,
},
String {
default: Option<String>,
},
Color {
default: Option<[f32; 3]>,
space: Option<Ustr>,
},
Point {
default: Option<[f32; 3]>,
space: Option<Ustr>,
},
Vector {
default: Option<[f32; 3]>,
space: Option<Ustr>,
},
Normal {
default: Option<[f32; 3]>,
space: Option<Ustr>,
},
Matrix {
default: Option<[f32; 16]>,
},
IntArray {
size: usize,
default: Option<Vec<i32>>,
},
FloatArray {
size: usize,
default: Option<Vec<f32>>,
},
StringArray {
size: usize,
default: Option<Vec<String>>,
},
ColorArray {
size: usize,
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
PointArray {
size: usize,
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
VectorArray {
size: usize,
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
NormalArray {
size: usize,
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
MatrixArray {
size: usize,
default: Option<Vec<[f32; 16]>>,
},
IntDynamicArray {
default: Option<Vec<i32>>,
},
FloatDynamicArray {
default: Option<Vec<f32>>,
},
StringDynamicArray {
default: Option<Vec<String>>,
},
ColorDynamicArray {
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
PointDynamicArray {
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
VectorDynamicArray {
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
NormalDynamicArray {
default: Option<Vec<[f32; 3]>>,
space: Option<Ustr>,
},
MatrixDynamicArray {
default: Option<Vec<[f32; 16]>>,
},
Closure {
closure_type: Ustr,
},
}Expand description
A typed parameter that unifies type information with its potential value.
This design makes it impossible to have type mismatches - you can’t accidentally assign an integer default to a color parameter, for example.
Variants§
Int
Integer parameter
Float
Float parameter
String
String parameter
Color
RGB color (3 floats)
Point
3D point (3 floats)
Vector
3D vector (3 floats)
Normal
Surface normal (3 floats)
Matrix
4x4 transformation matrix (16 floats)
IntArray
Fixed-size array of integers
FloatArray
Fixed-size array of floats
StringArray
Fixed-size array of strings
ColorArray
Fixed-size array of colors
PointArray
Fixed-size array of points
VectorArray
Fixed-size array of vectors
NormalArray
Fixed-size array of normals
MatrixArray
Fixed-size array of matrices
IntDynamicArray
Dynamic (unsized) array of integers
FloatDynamicArray
Dynamic array of floats
StringDynamicArray
Dynamic array of strings
ColorDynamicArray
Dynamic array of colors
PointDynamicArray
Dynamic array of points
VectorDynamicArray
Dynamic array of vectors
NormalDynamicArray
Dynamic array of normals
MatrixDynamicArray
Dynamic array of matrices
Closure
Closure (BSDF, etc.) - no default values
Implementations§
Source§impl TypedParameter
impl TypedParameter
Sourcepub fn has_default(&self) -> bool
pub fn has_default(&self) -> bool
Check if this parameter has a default value.
Sourcepub fn is_dynamic_array(&self) -> bool
pub fn is_dynamic_array(&self) -> bool
Check if this is a dynamic (unsized) array.
Sourcepub fn is_closure(&self) -> bool
pub fn is_closure(&self) -> bool
Check if this is a closure type.
Trait Implementations§
Source§impl Clone for TypedParameter
impl Clone for TypedParameter
Source§fn clone(&self) -> TypedParameter
fn clone(&self) -> TypedParameter
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for TypedParameter
impl Debug for TypedParameter
Source§impl Display for TypedParameter
impl Display for TypedParameter
Source§impl PartialEq for TypedParameter
impl PartialEq for TypedParameter
impl StructuralPartialEq for TypedParameter
Auto Trait Implementations§
impl Freeze for TypedParameter
impl RefUnwindSafe for TypedParameter
impl Send for TypedParameter
impl Sync for TypedParameter
impl Unpin for TypedParameter
impl UnwindSafe for TypedParameter
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);