#[non_exhaustive]pub struct ColumnConfigurationBuilder { /* private fields */ }
Expand description
A builder for ColumnConfiguration
.
Implementations§
Source§impl ColumnConfigurationBuilder
impl ColumnConfigurationBuilder
Sourcepub fn document_id_column_name(self, input: impl Into<String>) -> Self
pub fn document_id_column_name(self, input: impl Into<String>) -> Self
The column that provides the document's identifier.
This field is required.Sourcepub fn set_document_id_column_name(self, input: Option<String>) -> Self
pub fn set_document_id_column_name(self, input: Option<String>) -> Self
The column that provides the document's identifier.
Sourcepub fn get_document_id_column_name(&self) -> &Option<String>
pub fn get_document_id_column_name(&self) -> &Option<String>
The column that provides the document's identifier.
Sourcepub fn document_data_column_name(self, input: impl Into<String>) -> Self
pub fn document_data_column_name(self, input: impl Into<String>) -> Self
The column that contains the contents of the document.
This field is required.Sourcepub fn set_document_data_column_name(self, input: Option<String>) -> Self
pub fn set_document_data_column_name(self, input: Option<String>) -> Self
The column that contains the contents of the document.
Sourcepub fn get_document_data_column_name(&self) -> &Option<String>
pub fn get_document_data_column_name(&self) -> &Option<String>
The column that contains the contents of the document.
Sourcepub fn document_title_column_name(self, input: impl Into<String>) -> Self
pub fn document_title_column_name(self, input: impl Into<String>) -> Self
The column that contains the title of the document.
Sourcepub fn set_document_title_column_name(self, input: Option<String>) -> Self
pub fn set_document_title_column_name(self, input: Option<String>) -> Self
The column that contains the title of the document.
Sourcepub fn get_document_title_column_name(&self) -> &Option<String>
pub fn get_document_title_column_name(&self) -> &Option<String>
The column that contains the title of the document.
Sourcepub fn field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self
pub fn field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self
Appends an item to field_mappings
.
To override the contents of this collection use set_field_mappings
.
An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex
API.
Sourcepub fn set_field_mappings(
self,
input: Option<Vec<DataSourceToIndexFieldMapping>>,
) -> Self
pub fn set_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self
An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex
API.
Sourcepub fn get_field_mappings(&self) -> &Option<Vec<DataSourceToIndexFieldMapping>>
pub fn get_field_mappings(&self) -> &Option<Vec<DataSourceToIndexFieldMapping>>
An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex
API.
Sourcepub fn change_detecting_columns(self, input: impl Into<String>) -> Self
pub fn change_detecting_columns(self, input: impl Into<String>) -> Self
Appends an item to change_detecting_columns
.
To override the contents of this collection use set_change_detecting_columns
.
One to five columns that indicate when a document in the database has changed.
Sourcepub fn set_change_detecting_columns(self, input: Option<Vec<String>>) -> Self
pub fn set_change_detecting_columns(self, input: Option<Vec<String>>) -> Self
One to five columns that indicate when a document in the database has changed.
Sourcepub fn get_change_detecting_columns(&self) -> &Option<Vec<String>>
pub fn get_change_detecting_columns(&self) -> &Option<Vec<String>>
One to five columns that indicate when a document in the database has changed.
Sourcepub fn build(self) -> Result<ColumnConfiguration, BuildError>
pub fn build(self) -> Result<ColumnConfiguration, BuildError>
Consumes the builder and constructs a ColumnConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ColumnConfigurationBuilder
impl Clone for ColumnConfigurationBuilder
Source§fn clone(&self) -> ColumnConfigurationBuilder
fn clone(&self) -> ColumnConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ColumnConfigurationBuilder
impl Debug for ColumnConfigurationBuilder
Source§impl Default for ColumnConfigurationBuilder
impl Default for ColumnConfigurationBuilder
Source§fn default() -> ColumnConfigurationBuilder
fn default() -> ColumnConfigurationBuilder
impl StructuralPartialEq for ColumnConfigurationBuilder
Auto Trait Implementations§
impl Freeze for ColumnConfigurationBuilder
impl RefUnwindSafe for ColumnConfigurationBuilder
impl Send for ColumnConfigurationBuilder
impl Sync for ColumnConfigurationBuilder
impl Unpin for ColumnConfigurationBuilder
impl UnwindSafe for ColumnConfigurationBuilder
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);