#[non_exhaustive]pub struct SegmentDimensionsBuilder { /* private fields */ }Expand description
A builder for SegmentDimensions.
Implementations§
Source§impl SegmentDimensionsBuilder
impl SegmentDimensionsBuilder
Sourcepub fn attributes(self, k: impl Into<String>, v: AttributeDimension) -> Self
pub fn attributes(self, k: impl Into<String>, v: AttributeDimension) -> Self
Adds a key-value pair to attributes.
To override the contents of this collection use set_attributes.
One or more custom attributes to use as criteria for the segment.
Sourcepub fn set_attributes(
self,
input: Option<HashMap<String, AttributeDimension>>,
) -> Self
pub fn set_attributes( self, input: Option<HashMap<String, AttributeDimension>>, ) -> Self
One or more custom attributes to use as criteria for the segment.
Sourcepub fn get_attributes(&self) -> &Option<HashMap<String, AttributeDimension>>
pub fn get_attributes(&self) -> &Option<HashMap<String, AttributeDimension>>
One or more custom attributes to use as criteria for the segment.
Sourcepub fn behavior(self, input: SegmentBehaviors) -> Self
pub fn behavior(self, input: SegmentBehaviors) -> Self
The behavior-based criteria, such as how recently users have used your app, for the segment.
Sourcepub fn set_behavior(self, input: Option<SegmentBehaviors>) -> Self
pub fn set_behavior(self, input: Option<SegmentBehaviors>) -> Self
The behavior-based criteria, such as how recently users have used your app, for the segment.
Sourcepub fn get_behavior(&self) -> &Option<SegmentBehaviors>
pub fn get_behavior(&self) -> &Option<SegmentBehaviors>
The behavior-based criteria, such as how recently users have used your app, for the segment.
Sourcepub fn demographic(self, input: SegmentDemographics) -> Self
pub fn demographic(self, input: SegmentDemographics) -> Self
The demographic-based criteria, such as device platform, for the segment.
Sourcepub fn set_demographic(self, input: Option<SegmentDemographics>) -> Self
pub fn set_demographic(self, input: Option<SegmentDemographics>) -> Self
The demographic-based criteria, such as device platform, for the segment.
Sourcepub fn get_demographic(&self) -> &Option<SegmentDemographics>
pub fn get_demographic(&self) -> &Option<SegmentDemographics>
The demographic-based criteria, such as device platform, for the segment.
Sourcepub fn location(self, input: SegmentLocation) -> Self
pub fn location(self, input: SegmentLocation) -> Self
The location-based criteria, such as region or GPS coordinates, for the segment.
Sourcepub fn set_location(self, input: Option<SegmentLocation>) -> Self
pub fn set_location(self, input: Option<SegmentLocation>) -> Self
The location-based criteria, such as region or GPS coordinates, for the segment.
Sourcepub fn get_location(&self) -> &Option<SegmentLocation>
pub fn get_location(&self) -> &Option<SegmentLocation>
The location-based criteria, such as region or GPS coordinates, for the segment.
Sourcepub fn metrics(self, k: impl Into<String>, v: MetricDimension) -> Self
pub fn metrics(self, k: impl Into<String>, v: MetricDimension) -> Self
Adds a key-value pair to metrics.
To override the contents of this collection use set_metrics.
One or more custom metrics to use as criteria for the segment.
Sourcepub fn set_metrics(
self,
input: Option<HashMap<String, MetricDimension>>,
) -> Self
pub fn set_metrics( self, input: Option<HashMap<String, MetricDimension>>, ) -> Self
One or more custom metrics to use as criteria for the segment.
Sourcepub fn get_metrics(&self) -> &Option<HashMap<String, MetricDimension>>
pub fn get_metrics(&self) -> &Option<HashMap<String, MetricDimension>>
One or more custom metrics to use as criteria for the segment.
Sourcepub fn user_attributes(
self,
k: impl Into<String>,
v: AttributeDimension,
) -> Self
pub fn user_attributes( self, k: impl Into<String>, v: AttributeDimension, ) -> Self
Adds a key-value pair to user_attributes.
To override the contents of this collection use set_user_attributes.
One or more custom user attributes to use as criteria for the segment.
Sourcepub fn set_user_attributes(
self,
input: Option<HashMap<String, AttributeDimension>>,
) -> Self
pub fn set_user_attributes( self, input: Option<HashMap<String, AttributeDimension>>, ) -> Self
One or more custom user attributes to use as criteria for the segment.
Sourcepub fn get_user_attributes(
&self,
) -> &Option<HashMap<String, AttributeDimension>>
pub fn get_user_attributes( &self, ) -> &Option<HashMap<String, AttributeDimension>>
One or more custom user attributes to use as criteria for the segment.
Sourcepub fn build(self) -> SegmentDimensions
pub fn build(self) -> SegmentDimensions
Consumes the builder and constructs a SegmentDimensions.
Trait Implementations§
Source§impl Clone for SegmentDimensionsBuilder
impl Clone for SegmentDimensionsBuilder
Source§fn clone(&self) -> SegmentDimensionsBuilder
fn clone(&self) -> SegmentDimensionsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SegmentDimensionsBuilder
impl Debug for SegmentDimensionsBuilder
Source§impl Default for SegmentDimensionsBuilder
impl Default for SegmentDimensionsBuilder
Source§fn default() -> SegmentDimensionsBuilder
fn default() -> SegmentDimensionsBuilder
Source§impl PartialEq for SegmentDimensionsBuilder
impl PartialEq for SegmentDimensionsBuilder
impl StructuralPartialEq for SegmentDimensionsBuilder
Auto Trait Implementations§
impl Freeze for SegmentDimensionsBuilder
impl RefUnwindSafe for SegmentDimensionsBuilder
impl Send for SegmentDimensionsBuilder
impl Sync for SegmentDimensionsBuilder
impl Unpin for SegmentDimensionsBuilder
impl UnwindSafe for SegmentDimensionsBuilder
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);