#[non_exhaustive]pub struct GeospatialLayerItemBuilder { /* private fields */ }
Expand description
A builder for GeospatialLayerItem
.
Implementations§
Source§impl GeospatialLayerItemBuilder
impl GeospatialLayerItemBuilder
Sourcepub fn layer_id(self, input: impl Into<String>) -> Self
pub fn layer_id(self, input: impl Into<String>) -> Self
The ID of the layer.
This field is required.Sourcepub fn set_layer_id(self, input: Option<String>) -> Self
pub fn set_layer_id(self, input: Option<String>) -> Self
The ID of the layer.
Sourcepub fn get_layer_id(&self) -> &Option<String>
pub fn get_layer_id(&self) -> &Option<String>
The ID of the layer.
Sourcepub fn layer_type(self, input: GeospatialLayerType) -> Self
pub fn layer_type(self, input: GeospatialLayerType) -> Self
The layer type.
Sourcepub fn set_layer_type(self, input: Option<GeospatialLayerType>) -> Self
pub fn set_layer_type(self, input: Option<GeospatialLayerType>) -> Self
The layer type.
Sourcepub fn get_layer_type(&self) -> &Option<GeospatialLayerType>
pub fn get_layer_type(&self) -> &Option<GeospatialLayerType>
The layer type.
Sourcepub fn data_source(self, input: GeospatialDataSourceItem) -> Self
pub fn data_source(self, input: GeospatialDataSourceItem) -> Self
The data source for the layer.
Sourcepub fn set_data_source(self, input: Option<GeospatialDataSourceItem>) -> Self
pub fn set_data_source(self, input: Option<GeospatialDataSourceItem>) -> Self
The data source for the layer.
Sourcepub fn get_data_source(&self) -> &Option<GeospatialDataSourceItem>
pub fn get_data_source(&self) -> &Option<GeospatialDataSourceItem>
The data source for the layer.
Sourcepub fn label(self, input: impl Into<String>) -> Self
pub fn label(self, input: impl Into<String>) -> Self
The label that is displayed for the layer.
Sourcepub fn set_label(self, input: Option<String>) -> Self
pub fn set_label(self, input: Option<String>) -> Self
The label that is displayed for the layer.
Sourcepub fn visibility(self, input: Visibility) -> Self
pub fn visibility(self, input: Visibility) -> Self
The state of visibility for the layer.
Sourcepub fn set_visibility(self, input: Option<Visibility>) -> Self
pub fn set_visibility(self, input: Option<Visibility>) -> Self
The state of visibility for the layer.
Sourcepub fn get_visibility(&self) -> &Option<Visibility>
pub fn get_visibility(&self) -> &Option<Visibility>
The state of visibility for the layer.
Sourcepub fn layer_definition(self, input: GeospatialLayerDefinition) -> Self
pub fn layer_definition(self, input: GeospatialLayerDefinition) -> Self
The definition properties for a layer.
Sourcepub fn set_layer_definition(
self,
input: Option<GeospatialLayerDefinition>,
) -> Self
pub fn set_layer_definition( self, input: Option<GeospatialLayerDefinition>, ) -> Self
The definition properties for a layer.
Sourcepub fn get_layer_definition(&self) -> &Option<GeospatialLayerDefinition>
pub fn get_layer_definition(&self) -> &Option<GeospatialLayerDefinition>
The definition properties for a layer.
Sourcepub fn tooltip(self, input: TooltipOptions) -> Self
pub fn tooltip(self, input: TooltipOptions) -> Self
The display options for the visual tooltip.
Sourcepub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
pub fn set_tooltip(self, input: Option<TooltipOptions>) -> Self
The display options for the visual tooltip.
Sourcepub fn get_tooltip(&self) -> &Option<TooltipOptions>
pub fn get_tooltip(&self) -> &Option<TooltipOptions>
The display options for the visual tooltip.
Sourcepub fn join_definition(self, input: GeospatialLayerJoinDefinition) -> Self
pub fn join_definition(self, input: GeospatialLayerJoinDefinition) -> Self
The join definition properties for a layer.
Sourcepub fn set_join_definition(
self,
input: Option<GeospatialLayerJoinDefinition>,
) -> Self
pub fn set_join_definition( self, input: Option<GeospatialLayerJoinDefinition>, ) -> Self
The join definition properties for a layer.
Sourcepub fn get_join_definition(&self) -> &Option<GeospatialLayerJoinDefinition>
pub fn get_join_definition(&self) -> &Option<GeospatialLayerJoinDefinition>
The join definition properties for a layer.
Sourcepub fn actions(self, input: LayerCustomAction) -> Self
pub fn actions(self, input: LayerCustomAction) -> Self
Appends an item to actions
.
To override the contents of this collection use set_actions
.
A list of custom actions for a layer.
Sourcepub fn set_actions(self, input: Option<Vec<LayerCustomAction>>) -> Self
pub fn set_actions(self, input: Option<Vec<LayerCustomAction>>) -> Self
A list of custom actions for a layer.
Sourcepub fn get_actions(&self) -> &Option<Vec<LayerCustomAction>>
pub fn get_actions(&self) -> &Option<Vec<LayerCustomAction>>
A list of custom actions for a layer.
Sourcepub fn build(self) -> Result<GeospatialLayerItem, BuildError>
pub fn build(self) -> Result<GeospatialLayerItem, BuildError>
Consumes the builder and constructs a GeospatialLayerItem
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for GeospatialLayerItemBuilder
impl Clone for GeospatialLayerItemBuilder
Source§fn clone(&self) -> GeospatialLayerItemBuilder
fn clone(&self) -> GeospatialLayerItemBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GeospatialLayerItemBuilder
impl Debug for GeospatialLayerItemBuilder
Source§impl Default for GeospatialLayerItemBuilder
impl Default for GeospatialLayerItemBuilder
Source§fn default() -> GeospatialLayerItemBuilder
fn default() -> GeospatialLayerItemBuilder
impl StructuralPartialEq for GeospatialLayerItemBuilder
Auto Trait Implementations§
impl Freeze for GeospatialLayerItemBuilder
impl RefUnwindSafe for GeospatialLayerItemBuilder
impl Send for GeospatialLayerItemBuilder
impl Sync for GeospatialLayerItemBuilder
impl Unpin for GeospatialLayerItemBuilder
impl UnwindSafe for GeospatialLayerItemBuilder
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);