#[non_exhaustive]pub struct OccurrencesBuilder { /* private fields */ }
Expand description
A builder for Occurrences
.
Implementations§
Source§impl OccurrencesBuilder
impl OccurrencesBuilder
Sourcepub fn line_ranges(self, input: Range) -> Self
pub fn line_ranges(self, input: Range) -> Self
Appends an item to line_ranges
.
To override the contents of this collection use set_line_ranges
.
Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
Sourcepub fn set_line_ranges(self, input: Option<Vec<Range>>) -> Self
pub fn set_line_ranges(self, input: Option<Vec<Range>>) -> Self
Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
Sourcepub fn get_line_ranges(&self) -> &Option<Vec<Range>>
pub fn get_line_ranges(&self) -> &Option<Vec<Range>>
Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
Sourcepub fn offset_ranges(self, input: Range) -> Self
pub fn offset_ranges(self, input: Range) -> Self
Appends an item to offset_ranges
.
To override the contents of this collection use set_offset_ranges
.
Occurrences of sensitive data detected in a binary text file.
Sourcepub fn set_offset_ranges(self, input: Option<Vec<Range>>) -> Self
pub fn set_offset_ranges(self, input: Option<Vec<Range>>) -> Self
Occurrences of sensitive data detected in a binary text file.
Sourcepub fn get_offset_ranges(&self) -> &Option<Vec<Range>>
pub fn get_offset_ranges(&self) -> &Option<Vec<Range>>
Occurrences of sensitive data detected in a binary text file.
Sourcepub fn pages(self, input: Page) -> Self
pub fn pages(self, input: Page) -> Self
Appends an item to pages
.
To override the contents of this collection use set_pages
.
Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
Sourcepub fn set_pages(self, input: Option<Vec<Page>>) -> Self
pub fn set_pages(self, input: Option<Vec<Page>>) -> Self
Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
Sourcepub fn get_pages(&self) -> &Option<Vec<Page>>
pub fn get_pages(&self) -> &Option<Vec<Page>>
Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
Sourcepub fn records(self, input: Record) -> Self
pub fn records(self, input: Record) -> Self
Appends an item to records
.
To override the contents of this collection use set_records
.
Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.
Sourcepub fn set_records(self, input: Option<Vec<Record>>) -> Self
pub fn set_records(self, input: Option<Vec<Record>>) -> Self
Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.
Sourcepub fn get_records(&self) -> &Option<Vec<Record>>
pub fn get_records(&self) -> &Option<Vec<Record>>
Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.
Sourcepub fn cells(self, input: Cell) -> Self
pub fn cells(self, input: Cell) -> Self
Appends an item to cells
.
To override the contents of this collection use set_cells
.
Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
Sourcepub fn set_cells(self, input: Option<Vec<Cell>>) -> Self
pub fn set_cells(self, input: Option<Vec<Cell>>) -> Self
Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
Sourcepub fn get_cells(&self) -> &Option<Vec<Cell>>
pub fn get_cells(&self) -> &Option<Vec<Cell>>
Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
Sourcepub fn build(self) -> Occurrences
pub fn build(self) -> Occurrences
Consumes the builder and constructs a Occurrences
.
Trait Implementations§
Source§impl Clone for OccurrencesBuilder
impl Clone for OccurrencesBuilder
Source§fn clone(&self) -> OccurrencesBuilder
fn clone(&self) -> OccurrencesBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OccurrencesBuilder
impl Debug for OccurrencesBuilder
Source§impl Default for OccurrencesBuilder
impl Default for OccurrencesBuilder
Source§fn default() -> OccurrencesBuilder
fn default() -> OccurrencesBuilder
Source§impl PartialEq for OccurrencesBuilder
impl PartialEq for OccurrencesBuilder
impl StructuralPartialEq for OccurrencesBuilder
Auto Trait Implementations§
impl Freeze for OccurrencesBuilder
impl RefUnwindSafe for OccurrencesBuilder
impl Send for OccurrencesBuilder
impl Sync for OccurrencesBuilder
impl Unpin for OccurrencesBuilder
impl UnwindSafe for OccurrencesBuilder
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);