#[non_exhaustive]pub struct AttributeSuggestionsGetConfigBuilder { /* private fields */ }Expand description
A builder for AttributeSuggestionsGetConfig.
Implementations§
Source§impl AttributeSuggestionsGetConfigBuilder
impl AttributeSuggestionsGetConfigBuilder
Sourcepub fn suggestion_attributes(self, input: impl Into<String>) -> Self
pub fn suggestion_attributes(self, input: impl Into<String>) -> Self
Appends an item to suggestion_attributes.
To override the contents of this collection use set_suggestion_attributes.
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
Sourcepub fn set_suggestion_attributes(self, input: Option<Vec<String>>) -> Self
pub fn set_suggestion_attributes(self, input: Option<Vec<String>>) -> Self
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
Sourcepub fn get_suggestion_attributes(&self) -> &Option<Vec<String>>
pub fn get_suggestion_attributes(&self) -> &Option<Vec<String>>
The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.
Sourcepub fn additional_response_attributes(self, input: impl Into<String>) -> Self
pub fn additional_response_attributes(self, input: impl Into<String>) -> Self
Appends an item to additional_response_attributes.
To override the contents of this collection use set_additional_response_attributes.
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
Sourcepub fn set_additional_response_attributes(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_additional_response_attributes( self, input: Option<Vec<String>>, ) -> Self
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
Sourcepub fn get_additional_response_attributes(&self) -> &Option<Vec<String>>
pub fn get_additional_response_attributes(&self) -> &Option<Vec<String>>
The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.
Sourcepub fn attribute_filter(self, input: AttributeFilter) -> Self
pub fn attribute_filter(self, input: AttributeFilter) -> Self
Filters the search results based on document fields/attributes.
Sourcepub fn set_attribute_filter(self, input: Option<AttributeFilter>) -> Self
pub fn set_attribute_filter(self, input: Option<AttributeFilter>) -> Self
Filters the search results based on document fields/attributes.
Sourcepub fn get_attribute_filter(&self) -> &Option<AttributeFilter>
pub fn get_attribute_filter(&self) -> &Option<AttributeFilter>
Filters the search results based on document fields/attributes.
Sourcepub fn user_context(self, input: UserContext) -> Self
pub fn user_context(self, input: UserContext) -> Self
Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
Sourcepub fn set_user_context(self, input: Option<UserContext>) -> Self
pub fn set_user_context(self, input: Option<UserContext>) -> Self
Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
Sourcepub fn get_user_context(&self) -> &Option<UserContext>
pub fn get_user_context(&self) -> &Option<UserContext>
Applies user context filtering so that only users who are given access to certain documents see these document in their search results.
Sourcepub fn build(self) -> AttributeSuggestionsGetConfig
pub fn build(self) -> AttributeSuggestionsGetConfig
Consumes the builder and constructs a AttributeSuggestionsGetConfig.
Trait Implementations§
Source§impl Clone for AttributeSuggestionsGetConfigBuilder
impl Clone for AttributeSuggestionsGetConfigBuilder
Source§fn clone(&self) -> AttributeSuggestionsGetConfigBuilder
fn clone(&self) -> AttributeSuggestionsGetConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for AttributeSuggestionsGetConfigBuilder
impl Default for AttributeSuggestionsGetConfigBuilder
Source§fn default() -> AttributeSuggestionsGetConfigBuilder
fn default() -> AttributeSuggestionsGetConfigBuilder
Source§impl PartialEq for AttributeSuggestionsGetConfigBuilder
impl PartialEq for AttributeSuggestionsGetConfigBuilder
Source§fn eq(&self, other: &AttributeSuggestionsGetConfigBuilder) -> bool
fn eq(&self, other: &AttributeSuggestionsGetConfigBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for AttributeSuggestionsGetConfigBuilder
Auto Trait Implementations§
impl Freeze for AttributeSuggestionsGetConfigBuilder
impl RefUnwindSafe for AttributeSuggestionsGetConfigBuilder
impl Send for AttributeSuggestionsGetConfigBuilder
impl Sync for AttributeSuggestionsGetConfigBuilder
impl Unpin for AttributeSuggestionsGetConfigBuilder
impl UnwindSafe for AttributeSuggestionsGetConfigBuilder
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);