#[non_exhaustive]pub struct CreateComponentDataBuilder { /* private fields */ }
Expand description
A builder for CreateComponentData
.
Implementations§
Source§impl CreateComponentDataBuilder
impl CreateComponentDataBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the component
This field is required.Sourcepub fn source_id(self, input: impl Into<String>) -> Self
pub fn source_id(self, input: impl Into<String>) -> Self
The unique ID of the component in its original source system, such as Figma.
Sourcepub fn set_source_id(self, input: Option<String>) -> Self
pub fn set_source_id(self, input: Option<String>) -> Self
The unique ID of the component in its original source system, such as Figma.
Sourcepub fn get_source_id(&self) -> &Option<String>
pub fn get_source_id(&self) -> &Option<String>
The unique ID of the component in its original source system, such as Figma.
Sourcepub fn component_type(self, input: impl Into<String>) -> Self
pub fn component_type(self, input: impl Into<String>) -> Self
The component type. This can be an Amplify custom UI component or another custom component.
This field is required.Sourcepub fn set_component_type(self, input: Option<String>) -> Self
pub fn set_component_type(self, input: Option<String>) -> Self
The component type. This can be an Amplify custom UI component or another custom component.
Sourcepub fn get_component_type(&self) -> &Option<String>
pub fn get_component_type(&self) -> &Option<String>
The component type. This can be an Amplify custom UI component or another custom component.
Sourcepub fn properties(self, k: impl Into<String>, v: ComponentProperty) -> Self
pub fn properties(self, k: impl Into<String>, v: ComponentProperty) -> Self
Adds a key-value pair to properties
.
To override the contents of this collection use set_properties
.
Describes the component's properties.
Sourcepub fn set_properties(
self,
input: Option<HashMap<String, ComponentProperty>>,
) -> Self
pub fn set_properties( self, input: Option<HashMap<String, ComponentProperty>>, ) -> Self
Describes the component's properties.
Sourcepub fn get_properties(&self) -> &Option<HashMap<String, ComponentProperty>>
pub fn get_properties(&self) -> &Option<HashMap<String, ComponentProperty>>
Describes the component's properties.
Sourcepub fn children(self, input: ComponentChild) -> Self
pub fn children(self, input: ComponentChild) -> Self
Appends an item to children
.
To override the contents of this collection use set_children
.
A list of child components that are instances of the main component.
Sourcepub fn set_children(self, input: Option<Vec<ComponentChild>>) -> Self
pub fn set_children(self, input: Option<Vec<ComponentChild>>) -> Self
A list of child components that are instances of the main component.
Sourcepub fn get_children(&self) -> &Option<Vec<ComponentChild>>
pub fn get_children(&self) -> &Option<Vec<ComponentChild>>
A list of child components that are instances of the main component.
Sourcepub fn variants(self, input: ComponentVariant) -> Self
pub fn variants(self, input: ComponentVariant) -> Self
Appends an item to variants
.
To override the contents of this collection use set_variants
.
A list of the unique variants of this component.
Sourcepub fn set_variants(self, input: Option<Vec<ComponentVariant>>) -> Self
pub fn set_variants(self, input: Option<Vec<ComponentVariant>>) -> Self
A list of the unique variants of this component.
Sourcepub fn get_variants(&self) -> &Option<Vec<ComponentVariant>>
pub fn get_variants(&self) -> &Option<Vec<ComponentVariant>>
A list of the unique variants of this component.
Sourcepub fn overrides(self, k: impl Into<String>, v: HashMap<String, String>) -> Self
pub fn overrides(self, k: impl Into<String>, v: HashMap<String, String>) -> Self
Adds a key-value pair to overrides
.
To override the contents of this collection use set_overrides
.
Describes the component properties that can be overriden to customize an instance of the component.
Sourcepub fn set_overrides(
self,
input: Option<HashMap<String, HashMap<String, String>>>,
) -> Self
pub fn set_overrides( self, input: Option<HashMap<String, HashMap<String, String>>>, ) -> Self
Describes the component properties that can be overriden to customize an instance of the component.
Sourcepub fn get_overrides(&self) -> &Option<HashMap<String, HashMap<String, String>>>
pub fn get_overrides(&self) -> &Option<HashMap<String, HashMap<String, String>>>
Describes the component properties that can be overriden to customize an instance of the component.
Sourcepub fn binding_properties(
self,
k: impl Into<String>,
v: ComponentBindingPropertiesValue,
) -> Self
pub fn binding_properties( self, k: impl Into<String>, v: ComponentBindingPropertiesValue, ) -> Self
Adds a key-value pair to binding_properties
.
To override the contents of this collection use set_binding_properties
.
The data binding information for the component's properties.
Sourcepub fn set_binding_properties(
self,
input: Option<HashMap<String, ComponentBindingPropertiesValue>>,
) -> Self
pub fn set_binding_properties( self, input: Option<HashMap<String, ComponentBindingPropertiesValue>>, ) -> Self
The data binding information for the component's properties.
Sourcepub fn get_binding_properties(
&self,
) -> &Option<HashMap<String, ComponentBindingPropertiesValue>>
pub fn get_binding_properties( &self, ) -> &Option<HashMap<String, ComponentBindingPropertiesValue>>
The data binding information for the component's properties.
Sourcepub fn collection_properties(
self,
k: impl Into<String>,
v: ComponentDataConfiguration,
) -> Self
pub fn collection_properties( self, k: impl Into<String>, v: ComponentDataConfiguration, ) -> Self
Adds a key-value pair to collection_properties
.
To override the contents of this collection use set_collection_properties
.
The data binding configuration for customizing a component's properties. Use this for a collection component.
Sourcepub fn set_collection_properties(
self,
input: Option<HashMap<String, ComponentDataConfiguration>>,
) -> Self
pub fn set_collection_properties( self, input: Option<HashMap<String, ComponentDataConfiguration>>, ) -> Self
The data binding configuration for customizing a component's properties. Use this for a collection component.
Sourcepub fn get_collection_properties(
&self,
) -> &Option<HashMap<String, ComponentDataConfiguration>>
pub fn get_collection_properties( &self, ) -> &Option<HashMap<String, ComponentDataConfiguration>>
The data binding configuration for customizing a component's properties. Use this for a collection component.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
One or more key-value pairs to use when tagging the component data.
One or more key-value pairs to use when tagging the component data.
One or more key-value pairs to use when tagging the component data.
Sourcepub fn events(self, k: impl Into<String>, v: ComponentEvent) -> Self
pub fn events(self, k: impl Into<String>, v: ComponentEvent) -> Self
Adds a key-value pair to events
.
To override the contents of this collection use set_events
.
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
Sourcepub fn set_events(self, input: Option<HashMap<String, ComponentEvent>>) -> Self
pub fn set_events(self, input: Option<HashMap<String, ComponentEvent>>) -> Self
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
Sourcepub fn get_events(&self) -> &Option<HashMap<String, ComponentEvent>>
pub fn get_events(&self) -> &Option<HashMap<String, ComponentEvent>>
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
Sourcepub fn schema_version(self, input: impl Into<String>) -> Self
pub fn schema_version(self, input: impl Into<String>) -> Self
The schema version of the component when it was imported.
Sourcepub fn set_schema_version(self, input: Option<String>) -> Self
pub fn set_schema_version(self, input: Option<String>) -> Self
The schema version of the component when it was imported.
Sourcepub fn get_schema_version(&self) -> &Option<String>
pub fn get_schema_version(&self) -> &Option<String>
The schema version of the component when it was imported.
Sourcepub fn build(self) -> Result<CreateComponentData, BuildError>
pub fn build(self) -> Result<CreateComponentData, BuildError>
Consumes the builder and constructs a CreateComponentData
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for CreateComponentDataBuilder
impl Clone for CreateComponentDataBuilder
Source§fn clone(&self) -> CreateComponentDataBuilder
fn clone(&self) -> CreateComponentDataBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateComponentDataBuilder
impl Debug for CreateComponentDataBuilder
Source§impl Default for CreateComponentDataBuilder
impl Default for CreateComponentDataBuilder
Source§fn default() -> CreateComponentDataBuilder
fn default() -> CreateComponentDataBuilder
impl StructuralPartialEq for CreateComponentDataBuilder
Auto Trait Implementations§
impl Freeze for CreateComponentDataBuilder
impl RefUnwindSafe for CreateComponentDataBuilder
impl Send for CreateComponentDataBuilder
impl Sync for CreateComponentDataBuilder
impl Unpin for CreateComponentDataBuilder
impl UnwindSafe for CreateComponentDataBuilder
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);