pub struct DATA;
Expand description
Data context and validation.
This service enables data flow from a context to descendants, and from descendants up-to contexts, like an anonymous context var.
Arbitrary data can be set on a context using the data
property and retrieved using DATA.get
or DATA.req
.
Only one data entry and type can exist in a context, nested data
properties override the parent data and type in their context.
Annotation on the data can be set back using DATA.annotate
and can be retrieved using the get_data_notes
property,
annotations are classified by DataNoteLevel
, including INFO
, WARN
and ERROR
. For each level there are specialized
methods and properties, as an example, the DATA.invalidate
is used to set an error note, and the get_data_error_txt
property gets the error formatted for display. Data notes are aggregated from descendants up-to the context, continuing
up to outer nested contexts too, this means that you can get data errors for a form field by setting get_data_error_txt
on
the field widget, and get all form errors from that field and others by also setting get_data_error_txt
in the form widget.
Implementations§
source§impl DATA
impl DATA
sourcepub fn req<T: VarValue>(&self) -> ContextualizedVar<T>
pub fn req<T: VarValue>(&self) -> ContextualizedVar<T>
Require context data of type T
.
§Panics
Panics if the context data is not set to a variable of type T
on the first usage of the returned variable.
sourcepub fn get<T: VarValue>(
&self,
fallback: impl Fn() -> T + Send + Sync + 'static,
) -> ContextualizedVar<T>
pub fn get<T: VarValue>( &self, fallback: impl Fn() -> T + Send + Sync + 'static, ) -> ContextualizedVar<T>
Get context data of type T
if the context data is set with the same type, or gets the fallback
value.
sourcepub fn get_any(&self) -> BoxedAnyVar
pub fn get_any(&self) -> BoxedAnyVar
Gets the current context data.
Note that this does not return a contextualizing var like get
, it gets the data var in the calling context.
sourcepub fn annotate(
&self,
level: DataNoteLevel,
note: impl DataNoteValue,
) -> DataNoteHandle
pub fn annotate( &self, level: DataNoteLevel, note: impl DataNoteValue, ) -> DataNoteHandle
Insert a data note in the current context.
The note will stay in context until the context is unloaded or the handle is dropped.
sourcepub fn inform(&self, note: impl DataNoteValue) -> DataNoteHandle
pub fn inform(&self, note: impl DataNoteValue) -> DataNoteHandle
Insert an INFO
note in the current context.
The note will stay in context until the context is unloaded or the handle is dropped.
sourcepub fn warn(&self, note: impl DataNoteValue) -> DataNoteHandle
pub fn warn(&self, note: impl DataNoteValue) -> DataNoteHandle
Insert a WARN
note in the current context.
The note will stay in context until the context is unloaded or the handle is dropped.
sourcepub fn invalidate(&self, note: impl DataNoteValue) -> DataNoteHandle
pub fn invalidate(&self, note: impl DataNoteValue) -> DataNoteHandle
Insert an ERROR
note in the current context.
The note will stay in context until the context is unloaded or the handle is dropped.
sourcepub fn note_color(&self, level: impl IntoVar<DataNoteLevel>) -> impl Var<Rgba>
pub fn note_color(&self, level: impl IntoVar<DataNoteLevel>) -> impl Var<Rgba>
Read-only variable that is the best color for the note level in the context of the current color scheme.
If the level
is not found, gets the nearest less than level, if no color is set in the context gets
the black/white for dark/light.
The color can be used directly as text color, it probably needs mixing or desaturating to use as background.
sourcepub fn info_color(&self) -> impl Var<Rgba>
pub fn info_color(&self) -> impl Var<Rgba>
Read-only variable that is the best color for INFO
notes in the context of the current color scheme.
The color can be used directly as text color, it probably needs mixing or desaturating to use as background.
sourcepub fn warn_color(&self) -> impl Var<Rgba>
pub fn warn_color(&self) -> impl Var<Rgba>
Read-only variable that is the best color for WARN
notes in the context of the current color scheme.
The color can be used directly as text color, it probably needs mixing or desaturating to use as background.
sourcepub fn error_color(&self) -> impl Var<Rgba>
pub fn error_color(&self) -> impl Var<Rgba>
Read-only variable that is the best color for ERROR
notes in the context of the current color scheme.
The color can be used directly as text color, it probably needs mixing or desaturating to use as background.
Auto Trait Implementations§
impl Freeze for DATA
impl RefUnwindSafe for DATA
impl Send for DATA
impl Sync for DATA
impl Unpin for DATA
impl UnwindSafe for DATA
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
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more