#[non_exhaustive]pub struct VehicleStatusBuilder { /* private fields */ }
Expand description
A builder for VehicleStatus
.
Implementations§
Source§impl VehicleStatusBuilder
impl VehicleStatusBuilder
Sourcepub fn campaign_name(self, input: impl Into<String>) -> Self
pub fn campaign_name(self, input: impl Into<String>) -> Self
The name of a campaign.
Sourcepub fn set_campaign_name(self, input: Option<String>) -> Self
pub fn set_campaign_name(self, input: Option<String>) -> Self
The name of a campaign.
Sourcepub fn get_campaign_name(&self) -> &Option<String>
pub fn get_campaign_name(&self) -> &Option<String>
The name of a campaign.
Sourcepub fn vehicle_name(self, input: impl Into<String>) -> Self
pub fn vehicle_name(self, input: impl Into<String>) -> Self
The unique ID of the vehicle.
Sourcepub fn set_vehicle_name(self, input: Option<String>) -> Self
pub fn set_vehicle_name(self, input: Option<String>) -> Self
The unique ID of the vehicle.
Sourcepub fn get_vehicle_name(&self) -> &Option<String>
pub fn get_vehicle_name(&self) -> &Option<String>
The unique ID of the vehicle.
Sourcepub fn status(self, input: VehicleState) -> Self
pub fn status(self, input: VehicleState) -> Self
The status of a campaign, which can be one of the following:
-
CREATED
- The campaign exists but is not yet approved. -
READY
- The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet. -
HEALTHY
- The campaign is deployed to the vehicle. -
SUSPENDED
- The campaign is suspended and data collection is paused. -
DELETING
- The campaign is being removed from the vehicle. -
READY_FOR_CHECKIN
- The campaign is approved and waiting for vehicle check-in before deployment.
Sourcepub fn set_status(self, input: Option<VehicleState>) -> Self
pub fn set_status(self, input: Option<VehicleState>) -> Self
The status of a campaign, which can be one of the following:
-
CREATED
- The campaign exists but is not yet approved. -
READY
- The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet. -
HEALTHY
- The campaign is deployed to the vehicle. -
SUSPENDED
- The campaign is suspended and data collection is paused. -
DELETING
- The campaign is being removed from the vehicle. -
READY_FOR_CHECKIN
- The campaign is approved and waiting for vehicle check-in before deployment.
Sourcepub fn get_status(&self) -> &Option<VehicleState>
pub fn get_status(&self) -> &Option<VehicleState>
The status of a campaign, which can be one of the following:
-
CREATED
- The campaign exists but is not yet approved. -
READY
- The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet. -
HEALTHY
- The campaign is deployed to the vehicle. -
SUSPENDED
- The campaign is suspended and data collection is paused. -
DELETING
- The campaign is being removed from the vehicle. -
READY_FOR_CHECKIN
- The campaign is approved and waiting for vehicle check-in before deployment.
Sourcepub fn build(self) -> VehicleStatus
pub fn build(self) -> VehicleStatus
Consumes the builder and constructs a VehicleStatus
.
Trait Implementations§
Source§impl Clone for VehicleStatusBuilder
impl Clone for VehicleStatusBuilder
Source§fn clone(&self) -> VehicleStatusBuilder
fn clone(&self) -> VehicleStatusBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for VehicleStatusBuilder
impl Debug for VehicleStatusBuilder
Source§impl Default for VehicleStatusBuilder
impl Default for VehicleStatusBuilder
Source§fn default() -> VehicleStatusBuilder
fn default() -> VehicleStatusBuilder
Source§impl PartialEq for VehicleStatusBuilder
impl PartialEq for VehicleStatusBuilder
impl StructuralPartialEq for VehicleStatusBuilder
Auto Trait Implementations§
impl Freeze for VehicleStatusBuilder
impl RefUnwindSafe for VehicleStatusBuilder
impl Send for VehicleStatusBuilder
impl Sync for VehicleStatusBuilder
impl Unpin for VehicleStatusBuilder
impl UnwindSafe for VehicleStatusBuilder
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);