#[non_exhaustive]pub struct PropertyDefinitionRequest {
pub data_type: Option<DataType>,
pub is_required_in_entity: Option<bool>,
pub is_external_id: Option<bool>,
pub is_stored_externally: Option<bool>,
pub is_time_series: Option<bool>,
pub default_value: Option<DataValue>,
pub configuration: Option<HashMap<String, String>>,
pub display_name: Option<String>,
}
Expand description
An object that sets information about a property.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.data_type: Option<DataType>
An object that contains information about the data type.
is_required_in_entity: Option<bool>
A Boolean value that specifies whether the property is required.
is_external_id: Option<bool>
A Boolean value that specifies whether the property ID comes from an external data store.
is_stored_externally: Option<bool>
A Boolean value that specifies whether the property is stored externally.
is_time_series: Option<bool>
A Boolean value that specifies whether the property consists of time series data.
default_value: Option<DataValue>
An object that contains the default value.
configuration: Option<HashMap<String, String>>
A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
display_name: Option<String>
A friendly name for the property.
Implementations§
Source§impl PropertyDefinitionRequest
impl PropertyDefinitionRequest
Sourcepub fn data_type(&self) -> Option<&DataType>
pub fn data_type(&self) -> Option<&DataType>
An object that contains information about the data type.
Sourcepub fn is_required_in_entity(&self) -> Option<bool>
pub fn is_required_in_entity(&self) -> Option<bool>
A Boolean value that specifies whether the property is required.
Sourcepub fn is_external_id(&self) -> Option<bool>
pub fn is_external_id(&self) -> Option<bool>
A Boolean value that specifies whether the property ID comes from an external data store.
Sourcepub fn is_stored_externally(&self) -> Option<bool>
pub fn is_stored_externally(&self) -> Option<bool>
A Boolean value that specifies whether the property is stored externally.
Sourcepub fn is_time_series(&self) -> Option<bool>
pub fn is_time_series(&self) -> Option<bool>
A Boolean value that specifies whether the property consists of time series data.
Sourcepub fn default_value(&self) -> Option<&DataValue>
pub fn default_value(&self) -> Option<&DataValue>
An object that contains the default value.
Sourcepub fn configuration(&self) -> Option<&HashMap<String, String>>
pub fn configuration(&self) -> Option<&HashMap<String, String>>
A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
Sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
A friendly name for the property.
Source§impl PropertyDefinitionRequest
impl PropertyDefinitionRequest
Sourcepub fn builder() -> PropertyDefinitionRequestBuilder
pub fn builder() -> PropertyDefinitionRequestBuilder
Creates a new builder-style object to manufacture PropertyDefinitionRequest
.
Trait Implementations§
Source§impl Clone for PropertyDefinitionRequest
impl Clone for PropertyDefinitionRequest
Source§fn clone(&self) -> PropertyDefinitionRequest
fn clone(&self) -> PropertyDefinitionRequest
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PropertyDefinitionRequest
impl Debug for PropertyDefinitionRequest
impl StructuralPartialEq for PropertyDefinitionRequest
Auto Trait Implementations§
impl Freeze for PropertyDefinitionRequest
impl RefUnwindSafe for PropertyDefinitionRequest
impl Send for PropertyDefinitionRequest
impl Sync for PropertyDefinitionRequest
impl Unpin for PropertyDefinitionRequest
impl UnwindSafe for PropertyDefinitionRequest
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);