#[non_exhaustive]pub struct ComponentPropertyBuilder { /* private fields */ }
Expand description
A builder for ComponentProperty
.
Implementations§
Source§impl ComponentPropertyBuilder
impl ComponentPropertyBuilder
Sourcepub fn value(self, input: impl Into<String>) -> Self
pub fn value(self, input: impl Into<String>) -> Self
The value to assign to the component property.
Sourcepub fn set_value(self, input: Option<String>) -> Self
pub fn set_value(self, input: Option<String>) -> Self
The value to assign to the component property.
Sourcepub fn binding_properties(
self,
input: ComponentPropertyBindingProperties,
) -> Self
pub fn binding_properties( self, input: ComponentPropertyBindingProperties, ) -> Self
The information to bind the component property to data at runtime.
Sourcepub fn set_binding_properties(
self,
input: Option<ComponentPropertyBindingProperties>,
) -> Self
pub fn set_binding_properties( self, input: Option<ComponentPropertyBindingProperties>, ) -> Self
The information to bind the component property to data at runtime.
Sourcepub fn get_binding_properties(
&self,
) -> &Option<ComponentPropertyBindingProperties>
pub fn get_binding_properties( &self, ) -> &Option<ComponentPropertyBindingProperties>
The information to bind the component property to data at runtime.
Sourcepub fn collection_binding_properties(
self,
input: ComponentPropertyBindingProperties,
) -> Self
pub fn collection_binding_properties( self, input: ComponentPropertyBindingProperties, ) -> Self
The information to bind the component property to data at runtime. Use this for collection components.
Sourcepub fn set_collection_binding_properties(
self,
input: Option<ComponentPropertyBindingProperties>,
) -> Self
pub fn set_collection_binding_properties( self, input: Option<ComponentPropertyBindingProperties>, ) -> Self
The information to bind the component property to data at runtime. Use this for collection components.
Sourcepub fn get_collection_binding_properties(
&self,
) -> &Option<ComponentPropertyBindingProperties>
pub fn get_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, input: impl Into<String>) -> Self
pub fn default_value(self, input: impl Into<String>) -> Self
The default value to assign to the component property.
Sourcepub fn set_default_value(self, input: Option<String>) -> Self
pub fn set_default_value(self, input: Option<String>) -> Self
The default value to assign to the component property.
Sourcepub fn get_default_value(&self) -> &Option<String>
pub fn get_default_value(&self) -> &Option<String>
The default value to assign to the component property.
Sourcepub fn model(self, input: impl Into<String>) -> Self
pub fn model(self, input: impl Into<String>) -> Self
The data model to use to assign a value to the component property.
Sourcepub fn set_model(self, input: Option<String>) -> Self
pub fn set_model(self, input: Option<String>) -> Self
The data model to use to assign a value to the component property.
Sourcepub fn get_model(&self) -> &Option<String>
pub fn get_model(&self) -> &Option<String>
The data model to use to assign a value to the component property.
Sourcepub fn bindings(self, k: impl Into<String>, v: FormBindingElement) -> Self
pub fn bindings(self, k: impl Into<String>, v: FormBindingElement) -> Self
Adds a key-value pair to bindings
.
To override the contents of this collection use set_bindings
.
The information to bind the component property to form data.
Sourcepub fn set_bindings(
self,
input: Option<HashMap<String, FormBindingElement>>,
) -> Self
pub fn set_bindings( self, input: Option<HashMap<String, FormBindingElement>>, ) -> Self
The information to bind the component property to form data.
Sourcepub fn get_bindings(&self) -> &Option<HashMap<String, FormBindingElement>>
pub fn get_bindings(&self) -> &Option<HashMap<String, FormBindingElement>>
The information to bind the component property to form data.
Sourcepub fn event(self, input: impl Into<String>) -> Self
pub fn event(self, input: impl Into<String>) -> Self
An event that occurs in your app. Use this for workflow data binding.
Sourcepub fn set_event(self, input: Option<String>) -> Self
pub fn set_event(self, input: Option<String>) -> Self
An event that occurs in your app. Use this for workflow data binding.
Sourcepub fn get_event(&self) -> &Option<String>
pub fn get_event(&self) -> &Option<String>
An event that occurs in your app. Use this for workflow data binding.
Sourcepub fn user_attribute(self, input: impl Into<String>) -> Self
pub fn user_attribute(self, input: impl Into<String>) -> Self
An authenticated user attribute to use to assign a value to the component property.
Sourcepub fn set_user_attribute(self, input: Option<String>) -> Self
pub fn set_user_attribute(self, input: Option<String>) -> Self
An authenticated user attribute to use to assign a value to the component property.
Sourcepub fn get_user_attribute(&self) -> &Option<String>
pub fn get_user_attribute(&self) -> &Option<String>
An authenticated user attribute to use to assign a value to the component property.
Sourcepub fn concat(self, input: ComponentProperty) -> Self
pub fn concat(self, input: ComponentProperty) -> Self
Appends an item to concat
.
To override the contents of this collection use set_concat
.
A list of component properties to concatenate to create the value to assign to this component property.
Sourcepub fn set_concat(self, input: Option<Vec<ComponentProperty>>) -> Self
pub fn set_concat(self, input: Option<Vec<ComponentProperty>>) -> Self
A list of component properties to concatenate to create the value to assign to this component property.
Sourcepub fn get_concat(&self) -> &Option<Vec<ComponentProperty>>
pub fn get_concat(&self) -> &Option<Vec<ComponentProperty>>
A list of component properties to concatenate to create the value to assign to this component property.
Sourcepub fn condition(self, input: ComponentConditionProperty) -> Self
pub fn condition(self, input: ComponentConditionProperty) -> Self
The conditional expression to use to assign a value to the component property.
Sourcepub fn set_condition(self, input: Option<ComponentConditionProperty>) -> Self
pub fn set_condition(self, input: Option<ComponentConditionProperty>) -> Self
The conditional expression to use to assign a value to the component property.
Sourcepub fn get_condition(&self) -> &Option<ComponentConditionProperty>
pub fn get_condition(&self) -> &Option<ComponentConditionProperty>
The conditional expression to use to assign a value to the component property.
Sourcepub fn configured(self, input: bool) -> Self
pub fn configured(self, input: bool) -> Self
Specifies whether the user configured the property in Amplify Studio after importing it.
Sourcepub fn set_configured(self, input: Option<bool>) -> Self
pub fn set_configured(self, input: Option<bool>) -> Self
Specifies whether the user configured the property in Amplify Studio after importing it.
Sourcepub fn get_configured(&self) -> &Option<bool>
pub fn get_configured(&self) -> &Option<bool>
Specifies whether the user configured the property in Amplify Studio after importing it.
Sourcepub fn imported_value(self, input: impl Into<String>) -> Self
pub fn imported_value(self, input: impl Into<String>) -> Self
The default value assigned to the property when the component is imported into an app.
Sourcepub fn set_imported_value(self, input: Option<String>) -> Self
pub fn set_imported_value(self, input: Option<String>) -> Self
The default value assigned to the property when the component is imported into an app.
Sourcepub fn get_imported_value(&self) -> &Option<String>
pub fn get_imported_value(&self) -> &Option<String>
The default value assigned to the property when the component is imported into an app.
Sourcepub fn component_name(self, input: impl Into<String>) -> Self
pub fn component_name(self, input: impl Into<String>) -> Self
The name of the component that is affected by an event.
Sourcepub fn set_component_name(self, input: Option<String>) -> Self
pub fn set_component_name(self, input: Option<String>) -> Self
The name of the component that is affected by an event.
Sourcepub fn get_component_name(&self) -> &Option<String>
pub fn get_component_name(&self) -> &Option<String>
The name of the component that is affected by an event.
Sourcepub fn property(self, input: impl Into<String>) -> Self
pub fn property(self, input: impl Into<String>) -> Self
The name of the component's property that is affected by an event.
Sourcepub fn set_property(self, input: Option<String>) -> Self
pub fn set_property(self, input: Option<String>) -> Self
The name of the component's property that is affected by an event.
Sourcepub fn get_property(&self) -> &Option<String>
pub fn get_property(&self) -> &Option<String>
The name of the component's property that is affected by an event.
Sourcepub fn build(self) -> ComponentProperty
pub fn build(self) -> ComponentProperty
Consumes the builder and constructs a ComponentProperty
.
Trait Implementations§
Source§impl Clone for ComponentPropertyBuilder
impl Clone for ComponentPropertyBuilder
Source§fn clone(&self) -> ComponentPropertyBuilder
fn clone(&self) -> ComponentPropertyBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComponentPropertyBuilder
impl Debug for ComponentPropertyBuilder
Source§impl Default for ComponentPropertyBuilder
impl Default for ComponentPropertyBuilder
Source§fn default() -> ComponentPropertyBuilder
fn default() -> ComponentPropertyBuilder
Source§impl PartialEq for ComponentPropertyBuilder
impl PartialEq for ComponentPropertyBuilder
impl StructuralPartialEq for ComponentPropertyBuilder
Auto Trait Implementations§
impl Freeze for ComponentPropertyBuilder
impl RefUnwindSafe for ComponentPropertyBuilder
impl Send for ComponentPropertyBuilder
impl Sync for ComponentPropertyBuilder
impl Unpin for ComponentPropertyBuilder
impl UnwindSafe for ComponentPropertyBuilder
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);