#[non_exhaustive]pub struct DevicePositionBuilder { /* private fields */ }
Expand description
A builder for DevicePosition
.
Implementations§
Source§impl DevicePositionBuilder
impl DevicePositionBuilder
Sourcepub fn device_id(self, input: impl Into<String>) -> Self
pub fn device_id(self, input: impl Into<String>) -> Self
The device whose position you retrieved.
Sourcepub fn set_device_id(self, input: Option<String>) -> Self
pub fn set_device_id(self, input: Option<String>) -> Self
The device whose position you retrieved.
Sourcepub fn get_device_id(&self) -> &Option<String>
pub fn get_device_id(&self) -> &Option<String>
The device whose position you retrieved.
Sourcepub fn sample_time(self, input: DateTime) -> Self
pub fn sample_time(self, input: DateTime) -> Self
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
Sourcepub fn set_sample_time(self, input: Option<DateTime>) -> Self
pub fn set_sample_time(self, input: Option<DateTime>) -> Self
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
Sourcepub fn get_sample_time(&self) -> &Option<DateTime>
pub fn get_sample_time(&self) -> &Option<DateTime>
The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
Sourcepub fn received_time(self, input: DateTime) -> Self
pub fn received_time(self, input: DateTime) -> Self
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
Sourcepub fn set_received_time(self, input: Option<DateTime>) -> Self
pub fn set_received_time(self, input: Option<DateTime>) -> Self
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
Sourcepub fn get_received_time(&self) -> &Option<DateTime>
pub fn get_received_time(&self) -> &Option<DateTime>
The timestamp for when the tracker resource received the device position in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
Sourcepub fn position(self, input: f64) -> Self
pub fn position(self, input: f64) -> Self
Appends an item to position
.
To override the contents of this collection use set_position
.
The last known device position.
Sourcepub fn set_position(self, input: Option<Vec<f64>>) -> Self
pub fn set_position(self, input: Option<Vec<f64>>) -> Self
The last known device position.
Sourcepub fn get_position(&self) -> &Option<Vec<f64>>
pub fn get_position(&self) -> &Option<Vec<f64>>
The last known device position.
Sourcepub fn accuracy(self, input: PositionalAccuracy) -> Self
pub fn accuracy(self, input: PositionalAccuracy) -> Self
The accuracy of the device position.
Sourcepub fn set_accuracy(self, input: Option<PositionalAccuracy>) -> Self
pub fn set_accuracy(self, input: Option<PositionalAccuracy>) -> Self
The accuracy of the device position.
Sourcepub fn get_accuracy(&self) -> &Option<PositionalAccuracy>
pub fn get_accuracy(&self) -> &Option<PositionalAccuracy>
The accuracy of the device position.
Sourcepub fn position_properties(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn position_properties( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to position_properties
.
To override the contents of this collection use set_position_properties
.
The properties associated with the position.
Sourcepub fn set_position_properties(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_position_properties( self, input: Option<HashMap<String, String>>, ) -> Self
The properties associated with the position.
Sourcepub fn get_position_properties(&self) -> &Option<HashMap<String, String>>
pub fn get_position_properties(&self) -> &Option<HashMap<String, String>>
The properties associated with the position.
Sourcepub fn build(self) -> Result<DevicePosition, BuildError>
pub fn build(self) -> Result<DevicePosition, BuildError>
Consumes the builder and constructs a DevicePosition
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for DevicePositionBuilder
impl Clone for DevicePositionBuilder
Source§fn clone(&self) -> DevicePositionBuilder
fn clone(&self) -> DevicePositionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DevicePositionBuilder
impl Debug for DevicePositionBuilder
Source§impl Default for DevicePositionBuilder
impl Default for DevicePositionBuilder
Source§fn default() -> DevicePositionBuilder
fn default() -> DevicePositionBuilder
Source§impl PartialEq for DevicePositionBuilder
impl PartialEq for DevicePositionBuilder
impl StructuralPartialEq for DevicePositionBuilder
Auto Trait Implementations§
impl Freeze for DevicePositionBuilder
impl RefUnwindSafe for DevicePositionBuilder
impl Send for DevicePositionBuilder
impl Sync for DevicePositionBuilder
impl Unpin for DevicePositionBuilder
impl UnwindSafe for DevicePositionBuilder
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);