#[non_exhaustive]pub struct ComponentProperty {Show 15 fields
pub value: Option<String>,
pub binding_properties: Option<ComponentPropertyBindingProperties>,
pub collection_binding_properties: Option<ComponentPropertyBindingProperties>,
pub default_value: Option<String>,
pub model: Option<String>,
pub bindings: Option<HashMap<String, FormBindingElement>>,
pub event: Option<String>,
pub user_attribute: Option<String>,
pub concat: Option<Vec<ComponentProperty>>,
pub condition: Option<ComponentConditionProperty>,
pub configured: Option<bool>,
pub type: Option<String>,
pub imported_value: Option<String>,
pub component_name: Option<String>,
pub property: Option<String>,
}
Expand description
Describes the configuration for all of a component's properties. Use ComponentProperty
to specify the values to render or bind by default.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.value: Option<String>
The value to assign to the component property.
binding_properties: Option<ComponentPropertyBindingProperties>
The information to bind the component property to data at runtime.
collection_binding_properties: Option<ComponentPropertyBindingProperties>
The information to bind the component property to data at runtime. Use this for collection components.
default_value: Option<String>
The default value to assign to the component property.
model: Option<String>
The data model to use to assign a value to the component property.
bindings: Option<HashMap<String, FormBindingElement>>
The information to bind the component property to form data.
event: Option<String>
An event that occurs in your app. Use this for workflow data binding.
user_attribute: Option<String>
An authenticated user attribute to use to assign a value to the component property.
concat: Option<Vec<ComponentProperty>>
A list of component properties to concatenate to create the value to assign to this component property.
condition: Option<ComponentConditionProperty>
The conditional expression to use to assign a value to the component property.
configured: Option<bool>
Specifies whether the user configured the property in Amplify Studio after importing it.
type: Option<String>
The component type.
imported_value: Option<String>
The default value assigned to the property when the component is imported into an app.
component_name: Option<String>
The name of the component that is affected by an event.
property: Option<String>
The name of the component's property that is affected by an event.
Implementations§
Source§impl ComponentProperty
impl ComponentProperty
Sourcepub fn binding_properties(&self) -> Option<&ComponentPropertyBindingProperties>
pub fn binding_properties(&self) -> Option<&ComponentPropertyBindingProperties>
The information to bind the component property to data at runtime.
Sourcepub fn collection_binding_properties(
&self,
) -> Option<&ComponentPropertyBindingProperties>
pub fn collection_binding_properties( &self, ) -> Option<&ComponentPropertyBindingProperties>
The information to bind the component property to data at runtime. Use this for collection components.
Sourcepub fn default_value(&self) -> Option<&str>
pub fn default_value(&self) -> Option<&str>
The default value to assign to the component property.
Sourcepub fn model(&self) -> Option<&str>
pub fn model(&self) -> Option<&str>
The data model to use to assign a value to the component property.
Sourcepub fn bindings(&self) -> Option<&HashMap<String, FormBindingElement>>
pub fn bindings(&self) -> Option<&HashMap<String, FormBindingElement>>
The information to bind the component property to form data.
Sourcepub fn event(&self) -> Option<&str>
pub fn event(&self) -> Option<&str>
An event that occurs in your app. Use this for workflow data binding.
Sourcepub fn user_attribute(&self) -> Option<&str>
pub fn user_attribute(&self) -> Option<&str>
An authenticated user attribute to use to assign a value to the component property.
Sourcepub fn concat(&self) -> &[ComponentProperty]
pub fn concat(&self) -> &[ComponentProperty]
A list of component properties to concatenate to create the value to assign to this component property.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .concat.is_none()
.
Sourcepub fn condition(&self) -> Option<&ComponentConditionProperty>
pub fn condition(&self) -> Option<&ComponentConditionProperty>
The conditional expression to use to assign a value to the component property.
Sourcepub fn configured(&self) -> Option<bool>
pub fn configured(&self) -> Option<bool>
Specifies whether the user configured the property in Amplify Studio after importing it.
Sourcepub fn imported_value(&self) -> Option<&str>
pub fn imported_value(&self) -> Option<&str>
The default value assigned to the property when the component is imported into an app.
Sourcepub fn component_name(&self) -> Option<&str>
pub fn component_name(&self) -> Option<&str>
The name of the component that is affected by an event.
Source§impl ComponentProperty
impl ComponentProperty
Sourcepub fn builder() -> ComponentPropertyBuilder
pub fn builder() -> ComponentPropertyBuilder
Creates a new builder-style object to manufacture ComponentProperty
.
Trait Implementations§
Source§impl Clone for ComponentProperty
impl Clone for ComponentProperty
Source§fn clone(&self) -> ComponentProperty
fn clone(&self) -> ComponentProperty
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComponentProperty
impl Debug for ComponentProperty
Source§impl PartialEq for ComponentProperty
impl PartialEq for ComponentProperty
impl StructuralPartialEq for ComponentProperty
Auto Trait Implementations§
impl Freeze for ComponentProperty
impl RefUnwindSafe for ComponentProperty
impl Send for ComponentProperty
impl Sync for ComponentProperty
impl Unpin for ComponentProperty
impl UnwindSafe for ComponentProperty
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> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§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);