#[non_exhaustive]pub struct QueryRefinementBuilder { /* private fields */ }Expand description
A builder for QueryRefinement.
Implementations§
Source§impl QueryRefinementBuilder
impl QueryRefinementBuilder
Sourcepub fn refined_term(self, input: impl Into<String>) -> Self
pub fn refined_term(self, input: impl Into<String>) -> Self
The term that will be suggested to the user.
This field is required.Sourcepub fn set_refined_term(self, input: Option<String>) -> Self
pub fn set_refined_term(self, input: Option<String>) -> Self
The term that will be suggested to the user.
Sourcepub fn get_refined_term(&self) -> &Option<String>
pub fn get_refined_term(&self) -> &Option<String>
The term that will be suggested to the user.
Sourcepub fn original_term(self, input: impl Into<String>) -> Self
pub fn original_term(self, input: impl Into<String>) -> Self
The sub-string of the original query that is replaced by this query term.
This field is required.Sourcepub fn set_original_term(self, input: Option<String>) -> Self
pub fn set_original_term(self, input: Option<String>) -> Self
The sub-string of the original query that is replaced by this query term.
Sourcepub fn get_original_term(&self) -> &Option<String>
pub fn get_original_term(&self) -> &Option<String>
The sub-string of the original query that is replaced by this query term.
Sourcepub fn start_index(self, input: i32) -> Self
pub fn start_index(self, input: i32) -> Self
Start index of the parsed component.
This field is required.Sourcepub fn set_start_index(self, input: Option<i32>) -> Self
pub fn set_start_index(self, input: Option<i32>) -> Self
Start index of the parsed component.
Sourcepub fn get_start_index(&self) -> &Option<i32>
pub fn get_start_index(&self) -> &Option<i32>
Start index of the parsed component.
Sourcepub fn end_index(self, input: i32) -> Self
pub fn end_index(self, input: i32) -> Self
End index of the parsed query.
This field is required.Sourcepub fn set_end_index(self, input: Option<i32>) -> Self
pub fn set_end_index(self, input: Option<i32>) -> Self
End index of the parsed query.
Sourcepub fn get_end_index(&self) -> &Option<i32>
pub fn get_end_index(&self) -> &Option<i32>
End index of the parsed query.
Sourcepub fn build(self) -> Result<QueryRefinement, BuildError>
pub fn build(self) -> Result<QueryRefinement, BuildError>
Consumes the builder and constructs a QueryRefinement.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for QueryRefinementBuilder
impl Clone for QueryRefinementBuilder
Source§fn clone(&self) -> QueryRefinementBuilder
fn clone(&self) -> QueryRefinementBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for QueryRefinementBuilder
impl Debug for QueryRefinementBuilder
Source§impl Default for QueryRefinementBuilder
impl Default for QueryRefinementBuilder
Source§fn default() -> QueryRefinementBuilder
fn default() -> QueryRefinementBuilder
Source§impl PartialEq for QueryRefinementBuilder
impl PartialEq for QueryRefinementBuilder
impl StructuralPartialEq for QueryRefinementBuilder
Auto Trait Implementations§
impl Freeze for QueryRefinementBuilder
impl RefUnwindSafe for QueryRefinementBuilder
impl Send for QueryRefinementBuilder
impl Sync for QueryRefinementBuilder
impl Unpin for QueryRefinementBuilder
impl UnwindSafe for QueryRefinementBuilder
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);