pub struct Cursor<'a, T, A = Global>where
T: 'a,
A: Allocator,{ /* private fields */ }
linked_list_cursors
)mtls
only.Expand description
A cursor over a LinkedList
.
A Cursor
is like an iterator, except that it can freely seek back-and-forth.
Cursors always rest between two elements in the list, and index in a logically circular way.
To accommodate this, there is a โghostโ non-element that yields None
between the head and
tail of the list.
When created, cursors start at the front of the list, or the โghostโ non-element if the list is empty.
Implementationsยง
Sourceยงimpl<'a, T, A> Cursor<'a, T, A>where
A: Allocator,
impl<'a, T, A> Cursor<'a, T, A>where
A: Allocator,
Sourcepub fn index(&self) -> Option<usize>
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn index(&self) -> Option<usize>
linked_list_cursors
)Returns the cursor position index within the LinkedList
.
This returns None
if the cursor is currently pointing to the
โghostโ non-element.
Sourcepub fn move_next(&mut self)
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn move_next(&mut self)
linked_list_cursors
)Moves the cursor to the next element of the LinkedList
.
If the cursor is pointing to the โghostโ non-element then this will move it to
the first element of the LinkedList
. If it is pointing to the last
element of the LinkedList
then this will move it to the โghostโ non-element.
Sourcepub fn move_prev(&mut self)
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn move_prev(&mut self)
linked_list_cursors
)Moves the cursor to the previous element of the LinkedList
.
If the cursor is pointing to the โghostโ non-element then this will move it to
the last element of the LinkedList
. If it is pointing to the first
element of the LinkedList
then this will move it to the โghostโ non-element.
Sourcepub fn current(&self) -> Option<&'a T>
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn current(&self) -> Option<&'a T>
linked_list_cursors
)Returns a reference to the element that the cursor is currently pointing to.
This returns None
if the cursor is currently pointing to the
โghostโ non-element.
Sourcepub fn peek_next(&self) -> Option<&'a T>
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn peek_next(&self) -> Option<&'a T>
linked_list_cursors
)Returns a reference to the next element.
If the cursor is pointing to the โghostโ non-element then this returns
the first element of the LinkedList
. If it is pointing to the last
element of the LinkedList
then this returns None
.
Sourcepub fn peek_prev(&self) -> Option<&'a T>
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn peek_prev(&self) -> Option<&'a T>
linked_list_cursors
)Returns a reference to the previous element.
If the cursor is pointing to the โghostโ non-element then this returns
the last element of the LinkedList
. If it is pointing to the first
element of the LinkedList
then this returns None
.
Sourcepub fn front(&self) -> Option<&'a T>
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn front(&self) -> Option<&'a T>
linked_list_cursors
)Provides a reference to the front element of the cursorโs parent list, or None if the list is empty.
Sourcepub fn back(&self) -> Option<&'a T>
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn back(&self) -> Option<&'a T>
linked_list_cursors
)Provides a reference to the back element of the cursorโs parent list, or None if the list is empty.
Sourcepub fn as_list(&self) -> &'a LinkedList<T, A>
๐ฌThis is a nightly-only experimental API. (linked_list_cursors
)
pub fn as_list(&self) -> &'a LinkedList<T, A>
linked_list_cursors
)Provides a reference to the cursorโs parent list.
Trait Implementationsยง
impl<T, A> Send for Cursor<'_, T, A>
impl<T, A> Sync for Cursor<'_, T, A>
Auto Trait Implementationsยง
impl<'a, T, A> Freeze for Cursor<'a, T, A>
impl<'a, T, A> RefUnwindSafe for Cursor<'a, T, A>where
A: RefUnwindSafe,
T: RefUnwindSafe,
impl<'a, T, A> Unpin for Cursor<'a, T, A>
impl<'a, T, A> UnwindSafe for Cursor<'a, T, A>where
A: RefUnwindSafe,
T: RefUnwindSafe,
Blanket Implementationsยง
Sourceยงimpl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,
impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,
Sourceยงimpl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,
impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,
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> โ
ยงimpl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
ยงExample
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
ยงExample
println!("{}", value.bright_green());
Sourceยงfn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
ยงExample
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
ยงExample
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
ยงExample
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
ยงExample
println!("{}", value.on_bright_black());
Sourceยงfn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightRed
.
ยงExample
println!("{}", value.on_bright_red());
Sourceยงfn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
ยงExample
println!("{}", value.on_bright_green());
Sourceยงfn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
ยงExample
println!("{}", value.on_bright_yellow());
Sourceยงfn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
ยงExample
println!("{}", value.on_bright_blue());
Sourceยงfn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
ยงExample
println!("{}", value.on_bright_magenta());
Sourceยงfn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
ยงExample
println!("{}", value.on_bright_cyan());
Sourceยงfn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
ยงExample
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
ยงExample
println!("{}", value.underline());
Sourceยงfn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
ยงExample
println!("{}", value.rapid_blink());
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);