#[non_exhaustive]pub struct PropertiesBuilder { /* private fields */ }
Expand description
A builder for Properties
.
Implementations§
Source§impl PropertiesBuilder
impl PropertiesBuilder
Sourcepub fn eo_cloud_cover(self, input: f32) -> Self
pub fn eo_cloud_cover(self, input: f32) -> Self
Estimate of cloud cover.
Sourcepub fn set_eo_cloud_cover(self, input: Option<f32>) -> Self
pub fn set_eo_cloud_cover(self, input: Option<f32>) -> Self
Estimate of cloud cover.
Sourcepub fn get_eo_cloud_cover(&self) -> &Option<f32>
pub fn get_eo_cloud_cover(&self) -> &Option<f32>
Estimate of cloud cover.
Sourcepub fn view_off_nadir(self, input: f32) -> Self
pub fn view_off_nadir(self, input: f32) -> Self
The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
Sourcepub fn set_view_off_nadir(self, input: Option<f32>) -> Self
pub fn set_view_off_nadir(self, input: Option<f32>) -> Self
The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
Sourcepub fn get_view_off_nadir(&self) -> &Option<f32>
pub fn get_view_off_nadir(&self) -> &Option<f32>
The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
Sourcepub fn view_sun_azimuth(self, input: f32) -> Self
pub fn view_sun_azimuth(self, input: f32) -> Self
The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
Sourcepub fn set_view_sun_azimuth(self, input: Option<f32>) -> Self
pub fn set_view_sun_azimuth(self, input: Option<f32>) -> Self
The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
Sourcepub fn get_view_sun_azimuth(&self) -> &Option<f32>
pub fn get_view_sun_azimuth(&self) -> &Option<f32>
The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
Sourcepub fn view_sun_elevation(self, input: f32) -> Self
pub fn view_sun_elevation(self, input: f32) -> Self
The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.
Sourcepub fn set_view_sun_elevation(self, input: Option<f32>) -> Self
pub fn set_view_sun_elevation(self, input: Option<f32>) -> Self
The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.
Sourcepub fn get_view_sun_elevation(&self) -> &Option<f32>
pub fn get_view_sun_elevation(&self) -> &Option<f32>
The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.
Sourcepub fn platform(self, input: impl Into<String>) -> Self
pub fn platform(self, input: impl Into<String>) -> Self
Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
Sourcepub fn set_platform(self, input: Option<String>) -> Self
pub fn set_platform(self, input: Option<String>) -> Self
Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
Sourcepub fn get_platform(&self) -> &Option<String>
pub fn get_platform(&self) -> &Option<String>
Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
Sourcepub fn landsat_cloud_cover_land(self, input: f32) -> Self
pub fn landsat_cloud_cover_land(self, input: f32) -> Self
Land cloud cover for Landsat Data Collection.
Sourcepub fn set_landsat_cloud_cover_land(self, input: Option<f32>) -> Self
pub fn set_landsat_cloud_cover_land(self, input: Option<f32>) -> Self
Land cloud cover for Landsat Data Collection.
Sourcepub fn get_landsat_cloud_cover_land(&self) -> &Option<f32>
pub fn get_landsat_cloud_cover_land(&self) -> &Option<f32>
Land cloud cover for Landsat Data Collection.
Sourcepub fn build(self) -> Properties
pub fn build(self) -> Properties
Consumes the builder and constructs a Properties
.
Trait Implementations§
Source§impl Clone for PropertiesBuilder
impl Clone for PropertiesBuilder
Source§fn clone(&self) -> PropertiesBuilder
fn clone(&self) -> PropertiesBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PropertiesBuilder
impl Debug for PropertiesBuilder
Source§impl Default for PropertiesBuilder
impl Default for PropertiesBuilder
Source§fn default() -> PropertiesBuilder
fn default() -> PropertiesBuilder
Source§impl PartialEq for PropertiesBuilder
impl PartialEq for PropertiesBuilder
impl StructuralPartialEq for PropertiesBuilder
Auto Trait Implementations§
impl Freeze for PropertiesBuilder
impl RefUnwindSafe for PropertiesBuilder
impl Send for PropertiesBuilder
impl Sync for PropertiesBuilder
impl Unpin for PropertiesBuilder
impl UnwindSafe for PropertiesBuilder
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);