#[non_exhaustive]pub struct ComponentResponseBuilder { /* private fields */ }
Expand description
A builder for ComponentResponse
.
Implementations§
Source§impl ComponentResponseBuilder
impl ComponentResponseBuilder
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.
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.
Sourcepub fn get_component_name(&self) -> &Option<String>
pub fn get_component_name(&self) -> &Option<String>
The name of the component.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the component type.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the component type.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the component type.
Sourcepub fn component_type_id(self, input: impl Into<String>) -> Self
pub fn component_type_id(self, input: impl Into<String>) -> Self
The ID of the component type.
Sourcepub fn set_component_type_id(self, input: Option<String>) -> Self
pub fn set_component_type_id(self, input: Option<String>) -> Self
The ID of the component type.
Sourcepub fn get_component_type_id(&self) -> &Option<String>
pub fn get_component_type_id(&self) -> &Option<String>
The ID of the component type.
Sourcepub fn set_status(self, input: Option<Status>) -> Self
pub fn set_status(self, input: Option<Status>) -> Self
The status of the component type.
Sourcepub fn get_status(&self) -> &Option<Status>
pub fn get_status(&self) -> &Option<Status>
The status of the component type.
Sourcepub fn defined_in(self, input: impl Into<String>) -> Self
pub fn defined_in(self, input: impl Into<String>) -> Self
The name of the property definition set in the request.
Sourcepub fn set_defined_in(self, input: Option<String>) -> Self
pub fn set_defined_in(self, input: Option<String>) -> Self
The name of the property definition set in the request.
Sourcepub fn get_defined_in(&self) -> &Option<String>
pub fn get_defined_in(&self) -> &Option<String>
The name of the property definition set in the request.
Sourcepub fn properties(self, k: impl Into<String>, v: PropertyResponse) -> Self
pub fn properties(self, k: impl Into<String>, v: PropertyResponse) -> Self
Adds a key-value pair to properties
.
To override the contents of this collection use set_properties
.
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
Sourcepub fn set_properties(
self,
input: Option<HashMap<String, PropertyResponse>>,
) -> Self
pub fn set_properties( self, input: Option<HashMap<String, PropertyResponse>>, ) -> Self
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
Sourcepub fn get_properties(&self) -> &Option<HashMap<String, PropertyResponse>>
pub fn get_properties(&self) -> &Option<HashMap<String, PropertyResponse>>
An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
Sourcepub fn property_groups(
self,
k: impl Into<String>,
v: ComponentPropertyGroupResponse,
) -> Self
pub fn property_groups( self, k: impl Into<String>, v: ComponentPropertyGroupResponse, ) -> Self
Adds a key-value pair to property_groups
.
To override the contents of this collection use set_property_groups
.
The property groups.
Sourcepub fn set_property_groups(
self,
input: Option<HashMap<String, ComponentPropertyGroupResponse>>,
) -> Self
pub fn set_property_groups( self, input: Option<HashMap<String, ComponentPropertyGroupResponse>>, ) -> Self
The property groups.
Sourcepub fn get_property_groups(
&self,
) -> &Option<HashMap<String, ComponentPropertyGroupResponse>>
pub fn get_property_groups( &self, ) -> &Option<HashMap<String, ComponentPropertyGroupResponse>>
The property groups.
Sourcepub fn sync_source(self, input: impl Into<String>) -> Self
pub fn sync_source(self, input: impl Into<String>) -> Self
The syncSource of the sync job, if this entity was created by a sync job.
Sourcepub fn set_sync_source(self, input: Option<String>) -> Self
pub fn set_sync_source(self, input: Option<String>) -> Self
The syncSource of the sync job, if this entity was created by a sync job.
Sourcepub fn get_sync_source(&self) -> &Option<String>
pub fn get_sync_source(&self) -> &Option<String>
The syncSource of the sync job, if this entity was created by a sync job.
Sourcepub fn are_all_properties_returned(self, input: bool) -> Self
pub fn are_all_properties_returned(self, input: bool) -> Self
This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
Sourcepub fn set_are_all_properties_returned(self, input: Option<bool>) -> Self
pub fn set_are_all_properties_returned(self, input: Option<bool>) -> Self
This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
Sourcepub fn get_are_all_properties_returned(&self) -> &Option<bool>
pub fn get_are_all_properties_returned(&self) -> &Option<bool>
This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
Sourcepub fn composite_components(
self,
k: impl Into<String>,
v: ComponentSummary,
) -> Self
pub fn composite_components( self, k: impl Into<String>, v: ComponentSummary, ) -> Self
Adds a key-value pair to composite_components
.
To override the contents of this collection use set_composite_components
.
This lists objects that contain information about the compositeComponents
.
Sourcepub fn set_composite_components(
self,
input: Option<HashMap<String, ComponentSummary>>,
) -> Self
pub fn set_composite_components( self, input: Option<HashMap<String, ComponentSummary>>, ) -> Self
This lists objects that contain information about the compositeComponents
.
Sourcepub fn get_composite_components(
&self,
) -> &Option<HashMap<String, ComponentSummary>>
pub fn get_composite_components( &self, ) -> &Option<HashMap<String, ComponentSummary>>
This lists objects that contain information about the compositeComponents
.
Sourcepub fn are_all_composite_components_returned(self, input: bool) -> Self
pub fn are_all_composite_components_returned(self, input: bool) -> Self
This flag notes whether all compositeComponents
are returned in the API response.
Sourcepub fn set_are_all_composite_components_returned(
self,
input: Option<bool>,
) -> Self
pub fn set_are_all_composite_components_returned( self, input: Option<bool>, ) -> Self
This flag notes whether all compositeComponents
are returned in the API response.
Sourcepub fn get_are_all_composite_components_returned(&self) -> &Option<bool>
pub fn get_are_all_composite_components_returned(&self) -> &Option<bool>
This flag notes whether all compositeComponents
are returned in the API response.
Sourcepub fn build(self) -> ComponentResponse
pub fn build(self) -> ComponentResponse
Consumes the builder and constructs a ComponentResponse
.
Trait Implementations§
Source§impl Clone for ComponentResponseBuilder
impl Clone for ComponentResponseBuilder
Source§fn clone(&self) -> ComponentResponseBuilder
fn clone(&self) -> ComponentResponseBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComponentResponseBuilder
impl Debug for ComponentResponseBuilder
Source§impl Default for ComponentResponseBuilder
impl Default for ComponentResponseBuilder
Source§fn default() -> ComponentResponseBuilder
fn default() -> ComponentResponseBuilder
Source§impl PartialEq for ComponentResponseBuilder
impl PartialEq for ComponentResponseBuilder
impl StructuralPartialEq for ComponentResponseBuilder
Auto Trait Implementations§
impl Freeze for ComponentResponseBuilder
impl RefUnwindSafe for ComponentResponseBuilder
impl Send for ComponentResponseBuilder
impl Sync for ComponentResponseBuilder
impl Unpin for ComponentResponseBuilder
impl UnwindSafe for ComponentResponseBuilder
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);