#[non_exhaustive]pub struct ComponentChildBuilder { /* private fields */ }
Expand description
A builder for ComponentChild
.
Implementations§
Source§impl ComponentChildBuilder
impl ComponentChildBuilder
Sourcepub fn component_type(self, input: impl Into<String>) -> Self
pub fn component_type(self, input: impl Into<String>) -> Self
The type of the child 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 type of the child component.
Sourcepub fn get_component_type(&self) -> &Option<String>
pub fn get_component_type(&self) -> &Option<String>
The type of the child component.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the child component.
This field is required.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 properties of the child component. You can't specify tags
as a valid property for 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 properties of the child component. You can't specify tags
as a valid property for properties
.
Sourcepub fn get_properties(&self) -> &Option<HashMap<String, ComponentProperty>>
pub fn get_properties(&self) -> &Option<HashMap<String, ComponentProperty>>
Describes the properties of the child component. You can't specify tags
as a valid property for 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
.
The list of ComponentChild
instances for this component.
Sourcepub fn set_children(self, input: Option<Vec<ComponentChild>>) -> Self
pub fn set_children(self, input: Option<Vec<ComponentChild>>) -> Self
The list of ComponentChild
instances for this component.
Sourcepub fn get_children(&self) -> &Option<Vec<ComponentChild>>
pub fn get_children(&self) -> &Option<Vec<ComponentChild>>
The list of ComponentChild
instances for this component.
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
.
Describes the events that can be raised on the child 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
Describes the events that can be raised on the child 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>>
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
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 child 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 child 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 child component in its original source system, such as Figma.
Sourcepub fn build(self) -> Result<ComponentChild, BuildError>
pub fn build(self) -> Result<ComponentChild, BuildError>
Consumes the builder and constructs a ComponentChild
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ComponentChildBuilder
impl Clone for ComponentChildBuilder
Source§fn clone(&self) -> ComponentChildBuilder
fn clone(&self) -> ComponentChildBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComponentChildBuilder
impl Debug for ComponentChildBuilder
Source§impl Default for ComponentChildBuilder
impl Default for ComponentChildBuilder
Source§fn default() -> ComponentChildBuilder
fn default() -> ComponentChildBuilder
Source§impl PartialEq for ComponentChildBuilder
impl PartialEq for ComponentChildBuilder
impl StructuralPartialEq for ComponentChildBuilder
Auto Trait Implementations§
impl Freeze for ComponentChildBuilder
impl RefUnwindSafe for ComponentChildBuilder
impl Send for ComponentChildBuilder
impl Sync for ComponentChildBuilder
impl Unpin for ComponentChildBuilder
impl UnwindSafe for ComponentChildBuilder
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);