#[non_exhaustive]pub struct GridViewConfigurationBuilder { /* private fields */ }Expand description
A builder for GridViewConfiguration.
Implementations§
Source§impl GridViewConfigurationBuilder
impl GridViewConfigurationBuilder
Defines the layout of the video tiles when content sharing is enabled.
This field is required.Defines the layout of the video tiles when content sharing is enabled.
Defines the layout of the video tiles when content sharing is enabled.
Sourcepub fn presenter_only_configuration(
self,
input: PresenterOnlyConfiguration,
) -> Self
pub fn presenter_only_configuration( self, input: PresenterOnlyConfiguration, ) -> Self
Defines the configuration options for a presenter only video tile.
Sourcepub fn set_presenter_only_configuration(
self,
input: Option<PresenterOnlyConfiguration>,
) -> Self
pub fn set_presenter_only_configuration( self, input: Option<PresenterOnlyConfiguration>, ) -> Self
Defines the configuration options for a presenter only video tile.
Sourcepub fn get_presenter_only_configuration(
&self,
) -> &Option<PresenterOnlyConfiguration>
pub fn get_presenter_only_configuration( &self, ) -> &Option<PresenterOnlyConfiguration>
Defines the configuration options for a presenter only video tile.
Sourcepub fn active_speaker_only_configuration(
self,
input: ActiveSpeakerOnlyConfiguration,
) -> Self
pub fn active_speaker_only_configuration( self, input: ActiveSpeakerOnlyConfiguration, ) -> Self
The configuration settings for an ActiveSpeakerOnly video tile.
Sourcepub fn set_active_speaker_only_configuration(
self,
input: Option<ActiveSpeakerOnlyConfiguration>,
) -> Self
pub fn set_active_speaker_only_configuration( self, input: Option<ActiveSpeakerOnlyConfiguration>, ) -> Self
The configuration settings for an ActiveSpeakerOnly video tile.
Sourcepub fn get_active_speaker_only_configuration(
&self,
) -> &Option<ActiveSpeakerOnlyConfiguration>
pub fn get_active_speaker_only_configuration( &self, ) -> &Option<ActiveSpeakerOnlyConfiguration>
The configuration settings for an ActiveSpeakerOnly video tile.
Sourcepub fn horizontal_layout_configuration(
self,
input: HorizontalLayoutConfiguration,
) -> Self
pub fn horizontal_layout_configuration( self, input: HorizontalLayoutConfiguration, ) -> Self
The configuration settings for a horizontal layout.
Sourcepub fn set_horizontal_layout_configuration(
self,
input: Option<HorizontalLayoutConfiguration>,
) -> Self
pub fn set_horizontal_layout_configuration( self, input: Option<HorizontalLayoutConfiguration>, ) -> Self
The configuration settings for a horizontal layout.
Sourcepub fn get_horizontal_layout_configuration(
&self,
) -> &Option<HorizontalLayoutConfiguration>
pub fn get_horizontal_layout_configuration( &self, ) -> &Option<HorizontalLayoutConfiguration>
The configuration settings for a horizontal layout.
Sourcepub fn vertical_layout_configuration(
self,
input: VerticalLayoutConfiguration,
) -> Self
pub fn vertical_layout_configuration( self, input: VerticalLayoutConfiguration, ) -> Self
The configuration settings for a vertical layout.
Sourcepub fn set_vertical_layout_configuration(
self,
input: Option<VerticalLayoutConfiguration>,
) -> Self
pub fn set_vertical_layout_configuration( self, input: Option<VerticalLayoutConfiguration>, ) -> Self
The configuration settings for a vertical layout.
Sourcepub fn get_vertical_layout_configuration(
&self,
) -> &Option<VerticalLayoutConfiguration>
pub fn get_vertical_layout_configuration( &self, ) -> &Option<VerticalLayoutConfiguration>
The configuration settings for a vertical layout.
Sourcepub fn video_attribute(self, input: VideoAttribute) -> Self
pub fn video_attribute(self, input: VideoAttribute) -> Self
The attribute settings for the video tiles.
Sourcepub fn set_video_attribute(self, input: Option<VideoAttribute>) -> Self
pub fn set_video_attribute(self, input: Option<VideoAttribute>) -> Self
The attribute settings for the video tiles.
Sourcepub fn get_video_attribute(&self) -> &Option<VideoAttribute>
pub fn get_video_attribute(&self) -> &Option<VideoAttribute>
The attribute settings for the video tiles.
Sourcepub fn canvas_orientation(self, input: CanvasOrientation) -> Self
pub fn canvas_orientation(self, input: CanvasOrientation) -> Self
The orientation setting, horizontal or vertical.
Sourcepub fn set_canvas_orientation(self, input: Option<CanvasOrientation>) -> Self
pub fn set_canvas_orientation(self, input: Option<CanvasOrientation>) -> Self
The orientation setting, horizontal or vertical.
Sourcepub fn get_canvas_orientation(&self) -> &Option<CanvasOrientation>
pub fn get_canvas_orientation(&self) -> &Option<CanvasOrientation>
The orientation setting, horizontal or vertical.
Sourcepub fn build(self) -> Result<GridViewConfiguration, BuildError>
pub fn build(self) -> Result<GridViewConfiguration, BuildError>
Consumes the builder and constructs a GridViewConfiguration.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for GridViewConfigurationBuilder
impl Clone for GridViewConfigurationBuilder
Source§fn clone(&self) -> GridViewConfigurationBuilder
fn clone(&self) -> GridViewConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GridViewConfigurationBuilder
impl Debug for GridViewConfigurationBuilder
Source§impl Default for GridViewConfigurationBuilder
impl Default for GridViewConfigurationBuilder
Source§fn default() -> GridViewConfigurationBuilder
fn default() -> GridViewConfigurationBuilder
Source§impl PartialEq for GridViewConfigurationBuilder
impl PartialEq for GridViewConfigurationBuilder
Source§fn eq(&self, other: &GridViewConfigurationBuilder) -> bool
fn eq(&self, other: &GridViewConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for GridViewConfigurationBuilder
Auto Trait Implementations§
impl Freeze for GridViewConfigurationBuilder
impl RefUnwindSafe for GridViewConfigurationBuilder
impl Send for GridViewConfigurationBuilder
impl Sync for GridViewConfigurationBuilder
impl Unpin for GridViewConfigurationBuilder
impl UnwindSafe for GridViewConfigurationBuilder
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);