#[non_exhaustive]pub struct ItemSourceBuilder { /* private fields */ }
Expand description
A builder for ItemSource
.
Implementations§
Source§impl ItemSourceBuilder
impl ItemSourceBuilder
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
A unique Id for the source item.
This field is required.Sourcepub fn geometry(self, input: Geometry) -> Self
pub fn geometry(self, input: Geometry) -> Self
The item Geometry in GeoJson format.
This field is required.Sourcepub fn set_geometry(self, input: Option<Geometry>) -> Self
pub fn set_geometry(self, input: Option<Geometry>) -> Self
The item Geometry in GeoJson format.
Sourcepub fn get_geometry(&self) -> &Option<Geometry>
pub fn get_geometry(&self) -> &Option<Geometry>
The item Geometry in GeoJson format.
Sourcepub fn assets(self, k: impl Into<String>, v: AssetValue) -> Self
pub fn assets(self, k: impl Into<String>, v: AssetValue) -> Self
Adds a key-value pair to assets
.
To override the contents of this collection use set_assets
.
This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.
Sourcepub fn set_assets(self, input: Option<HashMap<String, AssetValue>>) -> Self
pub fn set_assets(self, input: Option<HashMap<String, AssetValue>>) -> Self
This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.
Sourcepub fn get_assets(&self) -> &Option<HashMap<String, AssetValue>>
pub fn get_assets(&self) -> &Option<HashMap<String, AssetValue>>
This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.
Sourcepub fn date_time(self, input: DateTime) -> Self
pub fn date_time(self, input: DateTime) -> Self
The searchable date and time of the item, in UTC.
This field is required.Sourcepub fn set_date_time(self, input: Option<DateTime>) -> Self
pub fn set_date_time(self, input: Option<DateTime>) -> Self
The searchable date and time of the item, in UTC.
Sourcepub fn get_date_time(&self) -> &Option<DateTime>
pub fn get_date_time(&self) -> &Option<DateTime>
The searchable date and time of the item, in UTC.
Sourcepub fn properties(self, input: Properties) -> Self
pub fn properties(self, input: Properties) -> Self
This field contains additional properties of the item.
Sourcepub fn set_properties(self, input: Option<Properties>) -> Self
pub fn set_properties(self, input: Option<Properties>) -> Self
This field contains additional properties of the item.
Sourcepub fn get_properties(&self) -> &Option<Properties>
pub fn get_properties(&self) -> &Option<Properties>
This field contains additional properties of the item.
Sourcepub fn build(self) -> Result<ItemSource, BuildError>
pub fn build(self) -> Result<ItemSource, BuildError>
Consumes the builder and constructs a ItemSource
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ItemSourceBuilder
impl Clone for ItemSourceBuilder
Source§fn clone(&self) -> ItemSourceBuilder
fn clone(&self) -> ItemSourceBuilder
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 ItemSourceBuilder
impl Debug for ItemSourceBuilder
Source§impl Default for ItemSourceBuilder
impl Default for ItemSourceBuilder
Source§fn default() -> ItemSourceBuilder
fn default() -> ItemSourceBuilder
Source§impl PartialEq for ItemSourceBuilder
impl PartialEq for ItemSourceBuilder
impl StructuralPartialEq for ItemSourceBuilder
Auto Trait Implementations§
impl Freeze for ItemSourceBuilder
impl RefUnwindSafe for ItemSourceBuilder
impl Send for ItemSourceBuilder
impl Sync for ItemSourceBuilder
impl Unpin for ItemSourceBuilder
impl UnwindSafe for ItemSourceBuilder
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);