#[non_exhaustive]pub struct FreeFormLayoutElement {
pub element_id: String,
pub element_type: LayoutElementType,
pub x_axis_location: String,
pub y_axis_location: String,
pub width: String,
pub height: String,
pub visibility: Option<Visibility>,
pub rendering_rules: Option<Vec<SheetElementRenderingRule>>,
pub border_style: Option<FreeFormLayoutElementBorderStyle>,
pub selected_border_style: Option<FreeFormLayoutElementBorderStyle>,
pub background_style: Option<FreeFormLayoutElementBackgroundStyle>,
pub loading_animation: Option<LoadingAnimation>,
}
Expand description
An element within a free-form layout.
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.element_id: String
A unique identifier for an element within a free-form layout.
element_type: LayoutElementType
The type of element.
x_axis_location: String
The x-axis coordinate of the element.
y_axis_location: String
The y-axis coordinate of the element.
width: String
The width of an element within a free-form layout.
height: String
The height of an element within a free-form layout.
visibility: Option<Visibility>
The visibility of an element within a free-form layout.
rendering_rules: Option<Vec<SheetElementRenderingRule>>
The rendering rules that determine when an element should be displayed within a free-form layout.
border_style: Option<FreeFormLayoutElementBorderStyle>
The border style configuration of a free-form layout element.
selected_border_style: Option<FreeFormLayoutElementBorderStyle>
The border style configuration of a free-form layout element. This border style is used when the element is selected.
background_style: Option<FreeFormLayoutElementBackgroundStyle>
The background style configuration of a free-form layout element.
loading_animation: Option<LoadingAnimation>
The loading animation configuration of a free-form layout element.
Implementations§
Source§impl FreeFormLayoutElement
impl FreeFormLayoutElement
Sourcepub fn element_id(&self) -> &str
pub fn element_id(&self) -> &str
A unique identifier for an element within a free-form layout.
Sourcepub fn element_type(&self) -> &LayoutElementType
pub fn element_type(&self) -> &LayoutElementType
The type of element.
Sourcepub fn x_axis_location(&self) -> &str
pub fn x_axis_location(&self) -> &str
The x-axis coordinate of the element.
Sourcepub fn y_axis_location(&self) -> &str
pub fn y_axis_location(&self) -> &str
The y-axis coordinate of the element.
Sourcepub fn visibility(&self) -> Option<&Visibility>
pub fn visibility(&self) -> Option<&Visibility>
The visibility of an element within a free-form layout.
Sourcepub fn rendering_rules(&self) -> &[SheetElementRenderingRule]
pub fn rendering_rules(&self) -> &[SheetElementRenderingRule]
The rendering rules that determine when an element should be displayed within a free-form layout.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .rendering_rules.is_none()
.
Sourcepub fn border_style(&self) -> Option<&FreeFormLayoutElementBorderStyle>
pub fn border_style(&self) -> Option<&FreeFormLayoutElementBorderStyle>
The border style configuration of a free-form layout element.
Sourcepub fn selected_border_style(&self) -> Option<&FreeFormLayoutElementBorderStyle>
pub fn selected_border_style(&self) -> Option<&FreeFormLayoutElementBorderStyle>
The border style configuration of a free-form layout element. This border style is used when the element is selected.
Sourcepub fn background_style(&self) -> Option<&FreeFormLayoutElementBackgroundStyle>
pub fn background_style(&self) -> Option<&FreeFormLayoutElementBackgroundStyle>
The background style configuration of a free-form layout element.
Sourcepub fn loading_animation(&self) -> Option<&LoadingAnimation>
pub fn loading_animation(&self) -> Option<&LoadingAnimation>
The loading animation configuration of a free-form layout element.
Source§impl FreeFormLayoutElement
impl FreeFormLayoutElement
Sourcepub fn builder() -> FreeFormLayoutElementBuilder
pub fn builder() -> FreeFormLayoutElementBuilder
Creates a new builder-style object to manufacture FreeFormLayoutElement
.
Trait Implementations§
Source§impl Clone for FreeFormLayoutElement
impl Clone for FreeFormLayoutElement
Source§fn clone(&self) -> FreeFormLayoutElement
fn clone(&self) -> FreeFormLayoutElement
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for FreeFormLayoutElement
impl Debug for FreeFormLayoutElement
Source§impl PartialEq for FreeFormLayoutElement
impl PartialEq for FreeFormLayoutElement
impl StructuralPartialEq for FreeFormLayoutElement
Auto Trait Implementations§
impl Freeze for FreeFormLayoutElement
impl RefUnwindSafe for FreeFormLayoutElement
impl Send for FreeFormLayoutElement
impl Sync for FreeFormLayoutElement
impl Unpin for FreeFormLayoutElement
impl UnwindSafe for FreeFormLayoutElement
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);