#[non_exhaustive]pub struct QQueryCardInputBuilder { /* private fields */ }
Expand description
A builder for QQueryCardInput
.
Implementations§
Source§impl QQueryCardInputBuilder
impl QQueryCardInputBuilder
Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
The title or label of the query card.
This field is required.Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The unique identifier of the query card.
This field is required.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 query 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 query card.
Sourcepub fn get_prompt(&self) -> &Option<String>
pub fn get_prompt(&self) -> &Option<String>
The prompt or instructions displayed for the query card.
Sourcepub fn output_source(self, input: CardOutputSource) -> Self
pub fn output_source(self, input: CardOutputSource) -> Self
The source or type of output to generate for the query card.
Sourcepub fn set_output_source(self, input: Option<CardOutputSource>) -> Self
pub fn set_output_source(self, input: Option<CardOutputSource>) -> Self
The source or type of output to generate for the query card.
Sourcepub fn get_output_source(&self) -> &Option<CardOutputSource>
pub fn get_output_source(&self) -> &Option<CardOutputSource>
The source or type of output to generate for the query card.
Sourcepub fn attribute_filter(self, input: AttributeFilter) -> Self
pub fn attribute_filter(self, input: AttributeFilter) -> Self
Turns on filtering of responses based on document attributes or metadata fields.
Sourcepub fn set_attribute_filter(self, input: Option<AttributeFilter>) -> Self
pub fn set_attribute_filter(self, input: Option<AttributeFilter>) -> Self
Turns on filtering of responses based on document attributes or metadata fields.
Sourcepub fn get_attribute_filter(&self) -> &Option<AttributeFilter>
pub fn get_attribute_filter(&self) -> &Option<AttributeFilter>
Turns on filtering of responses based on document attributes or metadata fields.
Sourcepub fn build(self) -> Result<QQueryCardInput, BuildError>
pub fn build(self) -> Result<QQueryCardInput, BuildError>
Consumes the builder and constructs a QQueryCardInput
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for QQueryCardInputBuilder
impl Clone for QQueryCardInputBuilder
Source§fn clone(&self) -> QQueryCardInputBuilder
fn clone(&self) -> QQueryCardInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for QQueryCardInputBuilder
impl Debug for QQueryCardInputBuilder
Source§impl Default for QQueryCardInputBuilder
impl Default for QQueryCardInputBuilder
Source§fn default() -> QQueryCardInputBuilder
fn default() -> QQueryCardInputBuilder
Source§impl PartialEq for QQueryCardInputBuilder
impl PartialEq for QQueryCardInputBuilder
impl StructuralPartialEq for QQueryCardInputBuilder
Auto Trait Implementations§
impl Freeze for QQueryCardInputBuilder
impl RefUnwindSafe for QQueryCardInputBuilder
impl Send for QQueryCardInputBuilder
impl Sync for QQueryCardInputBuilder
impl Unpin for QQueryCardInputBuilder
impl UnwindSafe for QQueryCardInputBuilder
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);