pub enum Handler {
Text(TextHandler),
Map(MapHandler),
List(ListHandler),
MovableList(MovableListHandler),
Tree(TreeHandler),
Unknown(UnknownHandler),
}
Variants§
Text(TextHandler)
Map(MapHandler)
List(ListHandler)
MovableList(MovableListHandler)
Tree(TreeHandler)
Unknown(UnknownHandler)
Implementations§
Source§impl Handler
impl Handler
Sourcepub fn as_text_mut(&mut self) -> Option<&mut TextHandler>
pub fn as_text_mut(&mut self) -> Option<&mut TextHandler>
Optionally returns mutable references to the inner fields if this is a Handler::Text
, otherwise None
Sourcepub fn as_text(&self) -> Option<&TextHandler>
pub fn as_text(&self) -> Option<&TextHandler>
Optionally returns references to the inner fields if this is a Handler::Text
, otherwise None
Sourcepub fn into_text(self) -> Result<TextHandler, Self>
pub fn into_text(self) -> Result<TextHandler, Self>
Returns the inner fields if this is a Handler::Text
, otherwise returns back the enum in the Err
case of the result
Sourcepub fn as_map_mut(&mut self) -> Option<&mut MapHandler>
pub fn as_map_mut(&mut self) -> Option<&mut MapHandler>
Optionally returns mutable references to the inner fields if this is a Handler::Map
, otherwise None
Sourcepub fn as_map(&self) -> Option<&MapHandler>
pub fn as_map(&self) -> Option<&MapHandler>
Optionally returns references to the inner fields if this is a Handler::Map
, otherwise None
Sourcepub fn into_map(self) -> Result<MapHandler, Self>
pub fn into_map(self) -> Result<MapHandler, Self>
Returns the inner fields if this is a Handler::Map
, otherwise returns back the enum in the Err
case of the result
Sourcepub fn as_list_mut(&mut self) -> Option<&mut ListHandler>
pub fn as_list_mut(&mut self) -> Option<&mut ListHandler>
Optionally returns mutable references to the inner fields if this is a Handler::List
, otherwise None
Sourcepub fn as_list(&self) -> Option<&ListHandler>
pub fn as_list(&self) -> Option<&ListHandler>
Optionally returns references to the inner fields if this is a Handler::List
, otherwise None
Sourcepub fn into_list(self) -> Result<ListHandler, Self>
pub fn into_list(self) -> Result<ListHandler, Self>
Returns the inner fields if this is a Handler::List
, otherwise returns back the enum in the Err
case of the result
Sourcepub fn is_movable_list(&self) -> bool
pub fn is_movable_list(&self) -> bool
Returns true if this is a Handler::MovableList
, otherwise false
Sourcepub fn as_movable_list_mut(&mut self) -> Option<&mut MovableListHandler>
pub fn as_movable_list_mut(&mut self) -> Option<&mut MovableListHandler>
Optionally returns mutable references to the inner fields if this is a Handler::MovableList
, otherwise None
Sourcepub fn as_movable_list(&self) -> Option<&MovableListHandler>
pub fn as_movable_list(&self) -> Option<&MovableListHandler>
Optionally returns references to the inner fields if this is a Handler::MovableList
, otherwise None
Sourcepub fn into_movable_list(self) -> Result<MovableListHandler, Self>
pub fn into_movable_list(self) -> Result<MovableListHandler, Self>
Returns the inner fields if this is a Handler::MovableList
, otherwise returns back the enum in the Err
case of the result
Sourcepub fn as_tree_mut(&mut self) -> Option<&mut TreeHandler>
pub fn as_tree_mut(&mut self) -> Option<&mut TreeHandler>
Optionally returns mutable references to the inner fields if this is a Handler::Tree
, otherwise None
Sourcepub fn as_tree(&self) -> Option<&TreeHandler>
pub fn as_tree(&self) -> Option<&TreeHandler>
Optionally returns references to the inner fields if this is a Handler::Tree
, otherwise None
Sourcepub fn into_tree(self) -> Result<TreeHandler, Self>
pub fn into_tree(self) -> Result<TreeHandler, Self>
Returns the inner fields if this is a Handler::Tree
, otherwise returns back the enum in the Err
case of the result
Sourcepub fn is_unknown(&self) -> bool
pub fn is_unknown(&self) -> bool
Returns true if this is a Handler::Unknown
, otherwise false
Sourcepub fn as_unknown_mut(&mut self) -> Option<&mut UnknownHandler>
pub fn as_unknown_mut(&mut self) -> Option<&mut UnknownHandler>
Optionally returns mutable references to the inner fields if this is a Handler::Unknown
, otherwise None
Sourcepub fn as_unknown(&self) -> Option<&UnknownHandler>
pub fn as_unknown(&self) -> Option<&UnknownHandler>
Optionally returns references to the inner fields if this is a Handler::Unknown
, otherwise None
Sourcepub fn into_unknown(self) -> Result<UnknownHandler, Self>
pub fn into_unknown(self) -> Result<UnknownHandler, Self>
Returns the inner fields if this is a Handler::Unknown
, otherwise returns back the enum in the Err
case of the result
Source§impl Handler
impl Handler
pub fn id(&self) -> ContainerID
pub fn c_type(&self) -> ContainerType
pub fn clear(&self) -> LoroResult<()>
Trait Implementations§
Source§impl HandlerTrait for Handler
impl HandlerTrait for Handler
fn is_attached(&self) -> bool
fn attached_handler(&self) -> Option<&BasicHandler>
fn get_value(&self) -> LoroValue
fn get_deep_value(&self) -> LoroValue
fn kind(&self) -> ContainerType
fn to_handler(&self) -> Handler
Source§fn attach(
&self,
txn: &mut Transaction,
parent: &BasicHandler,
self_id: ContainerID,
) -> LoroResult<Self>
fn attach( &self, txn: &mut Transaction, parent: &BasicHandler, self_id: ContainerID, ) -> LoroResult<Self>
Source§fn get_attached(&self) -> Option<Self>
fn get_attached(&self) -> Option<Self>
fn from_handler(h: Handler) -> Option<Self>
fn doc(&self) -> Option<LoroDoc>
fn parent(&self) -> Option<Handler>
fn idx(&self) -> ContainerIdx
fn id(&self) -> ContainerID
fn with_state<R>( &self, f: impl FnOnce(&mut State) -> LoroResult<R>, ) -> LoroResult<R>
Auto Trait Implementations§
impl Freeze for Handler
impl RefUnwindSafe for Handler
impl Send for Handler
impl Sync for Handler
impl Unpin for Handler
impl UnwindSafe for Handler
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);