#[non_exhaustive]pub struct QPluginCardBuilder { /* private fields */ }
Expand description
A builder for QPluginCard
.
Implementations§
Source§impl QPluginCardBuilder
impl QPluginCardBuilder
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The unique identifier of the plugin card.
This field is required.Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
The title or label of the plugin card.
This field is required.Sourcepub fn dependencies(self, input: impl Into<String>) -> Self
pub fn dependencies(self, input: impl Into<String>) -> Self
Appends an item to dependencies
.
To override the contents of this collection use set_dependencies
.
Any dependencies or requirements for the plugin card.
Sourcepub fn set_dependencies(self, input: Option<Vec<String>>) -> Self
pub fn set_dependencies(self, input: Option<Vec<String>>) -> Self
Any dependencies or requirements for the plugin card.
Sourcepub fn get_dependencies(&self) -> &Option<Vec<String>>
pub fn get_dependencies(&self) -> &Option<Vec<String>>
Any dependencies or requirements for the plugin card.
Sourcepub fn prompt(self, input: impl Into<String>) -> Self
pub fn prompt(self, input: impl Into<String>) -> Self
The prompt or instructions displayed for the plugin card.
This field is required.Sourcepub fn set_prompt(self, input: Option<String>) -> Self
pub fn set_prompt(self, input: Option<String>) -> Self
The prompt or instructions displayed for the plugin card.
Sourcepub fn get_prompt(&self) -> &Option<String>
pub fn get_prompt(&self) -> &Option<String>
The prompt or instructions displayed for the plugin card.
Sourcepub fn plugin_type(self, input: PluginType) -> Self
pub fn plugin_type(self, input: PluginType) -> Self
The type or category of the plugin used by the card.
This field is required.Sourcepub fn set_plugin_type(self, input: Option<PluginType>) -> Self
pub fn set_plugin_type(self, input: Option<PluginType>) -> Self
The type or category of the plugin used by the card.
Sourcepub fn get_plugin_type(&self) -> &Option<PluginType>
pub fn get_plugin_type(&self) -> &Option<PluginType>
The type or category of the plugin used by the card.
Sourcepub fn plugin_id(self, input: impl Into<String>) -> Self
pub fn plugin_id(self, input: impl Into<String>) -> Self
The unique identifier of the plugin used by the card.
This field is required.Sourcepub fn set_plugin_id(self, input: Option<String>) -> Self
pub fn set_plugin_id(self, input: Option<String>) -> Self
The unique identifier of the plugin used by the card.
Sourcepub fn get_plugin_id(&self) -> &Option<String>
pub fn get_plugin_id(&self) -> &Option<String>
The unique identifier of the plugin used by the card.
Sourcepub fn action_identifier(self, input: impl Into<String>) -> Self
pub fn action_identifier(self, input: impl Into<String>) -> Self
The action identifier of the action to be performed by the plugin card.
Sourcepub fn set_action_identifier(self, input: Option<String>) -> Self
pub fn set_action_identifier(self, input: Option<String>) -> Self
The action identifier of the action to be performed by the plugin card.
Sourcepub fn get_action_identifier(&self) -> &Option<String>
pub fn get_action_identifier(&self) -> &Option<String>
The action identifier of the action to be performed by the plugin card.
Sourcepub fn build(self) -> Result<QPluginCard, BuildError>
pub fn build(self) -> Result<QPluginCard, BuildError>
Consumes the builder and constructs a QPluginCard
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for QPluginCardBuilder
impl Clone for QPluginCardBuilder
Source§fn clone(&self) -> QPluginCardBuilder
fn clone(&self) -> QPluginCardBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for QPluginCardBuilder
impl Debug for QPluginCardBuilder
Source§impl Default for QPluginCardBuilder
impl Default for QPluginCardBuilder
Source§fn default() -> QPluginCardBuilder
fn default() -> QPluginCardBuilder
Source§impl PartialEq for QPluginCardBuilder
impl PartialEq for QPluginCardBuilder
impl StructuralPartialEq for QPluginCardBuilder
Auto Trait Implementations§
impl Freeze for QPluginCardBuilder
impl RefUnwindSafe for QPluginCardBuilder
impl Send for QPluginCardBuilder
impl Sync for QPluginCardBuilder
impl Unpin for QPluginCardBuilder
impl UnwindSafe for QPluginCardBuilder
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);