#[non_exhaustive]pub enum CountryCode {
Show 251 variants
Ad,
Ae,
Af,
Ag,
Ai,
Al,
Am,
Ao,
Aq,
Ar,
As,
At,
Au,
Aw,
Ax,
Az,
Ba,
Bb,
Bd,
Be,
Bf,
Bg,
Bh,
Bi,
Bj,
Bl,
Bm,
Bn,
Bo,
Bq,
Br,
Bs,
Bt,
Bv,
Bw,
By,
Bz,
Ca,
Cc,
Cd,
Cf,
Cg,
Ch,
Ci,
Ck,
Cl,
Cm,
Cn,
Co,
Cr,
Cu,
Cv,
Cw,
Cx,
Cy,
Cz,
De,
Dj,
Dk,
Dm,
Do,
Dz,
Ec,
Ee,
Eg,
Eh,
Er,
Es,
Et,
Fi,
Fj,
Fk,
Fm,
Fo,
Fr,
Ga,
Gb,
Gd,
Ge,
Gf,
Gg,
Gh,
Gi,
Gl,
Gm,
Gn,
Gp,
Gq,
Gr,
Gs,
Gt,
Gu,
Gw,
Gy,
Hk,
Hm,
Hn,
Hr,
Ht,
Hu,
Id,
Ie,
Il,
Im,
In,
Io,
Iq,
Ir,
Is,
It,
Je,
Jm,
Jo,
Jp,
Ke,
Kg,
Kh,
Ki,
Km,
Kn,
Kp,
Kr,
Kw,
Ky,
Kz,
La,
Lb,
Lc,
Li,
Lk,
Lr,
Ls,
Lt,
Lu,
Lv,
Ly,
Ma,
Mc,
Md,
Me,
Mf,
Mg,
Mh,
Mk,
Ml,
Mm,
Mn,
Mo,
Mp,
Mq,
Mr,
Ms,
Mt,
Mu,
Mv,
Mw,
Mx,
My,
Mz,
Na,
Nc,
Ne,
Nf,
Ng,
Ni,
Nl,
No,
Np,
Nr,
Nu,
Nz,
Om,
Pa,
Pe,
Pf,
Pg,
Ph,
Pk,
Pl,
Pm,
Pn,
Pr,
Ps,
Pt,
Pw,
Py,
Qa,
Re,
Ro,
Rs,
Ru,
Rw,
Sa,
Sb,
Sc,
Sd,
Se,
Sg,
Sh,
Si,
Sj,
Sk,
Sl,
Sm,
Sn,
So,
Sr,
Ss,
St,
Sv,
Sx,
Sy,
Sz,
Tc,
Td,
Tf,
Tg,
Th,
Tj,
Tk,
Tl,
Tm,
Tn,
To,
Tr,
Tt,
Tv,
Tw,
Tz,
Ua,
Ug,
Um,
Us,
Uy,
Uz,
Va,
Vc,
Ve,
Vg,
Vi,
Vn,
Vu,
Wf,
Ws,
Xk,
Ye,
Yt,
Za,
Zm,
Zw,
Unknown(UnknownVariantValue),
}
Expand description
When writing a match expression against CountryCode
, it is important to ensure
your code is forward-compatible. That is, if a match arm handles a case for a
feature that is supported by the service but has not been represented as an enum
variant in a current version of SDK, your code should continue to work when you
upgrade SDK to a future version in which the enum does include a variant for that
feature.
Here is an example of how you can make a match expression forward-compatible:
# let countrycode = unimplemented!();
match countrycode {
CountryCode::Ad => { /* ... */ },
CountryCode::Ae => { /* ... */ },
CountryCode::Af => { /* ... */ },
CountryCode::Ag => { /* ... */ },
CountryCode::Ai => { /* ... */ },
CountryCode::Al => { /* ... */ },
CountryCode::Am => { /* ... */ },
CountryCode::Ao => { /* ... */ },
CountryCode::Aq => { /* ... */ },
CountryCode::Ar => { /* ... */ },
CountryCode::As => { /* ... */ },
CountryCode::At => { /* ... */ },
CountryCode::Au => { /* ... */ },
CountryCode::Aw => { /* ... */ },
CountryCode::Ax => { /* ... */ },
CountryCode::Az => { /* ... */ },
CountryCode::Ba => { /* ... */ },
CountryCode::Bb => { /* ... */ },
CountryCode::Bd => { /* ... */ },
CountryCode::Be => { /* ... */ },
CountryCode::Bf => { /* ... */ },
CountryCode::Bg => { /* ... */ },
CountryCode::Bh => { /* ... */ },
CountryCode::Bi => { /* ... */ },
CountryCode::Bj => { /* ... */ },
CountryCode::Bl => { /* ... */ },
CountryCode::Bm => { /* ... */ },
CountryCode::Bn => { /* ... */ },
CountryCode::Bo => { /* ... */ },
CountryCode::Bq => { /* ... */ },
CountryCode::Br => { /* ... */ },
CountryCode::Bs => { /* ... */ },
CountryCode::Bt => { /* ... */ },
CountryCode::Bv => { /* ... */ },
CountryCode::Bw => { /* ... */ },
CountryCode::By => { /* ... */ },
CountryCode::Bz => { /* ... */ },
CountryCode::Ca => { /* ... */ },
CountryCode::Cc => { /* ... */ },
CountryCode::Cd => { /* ... */ },
CountryCode::Cf => { /* ... */ },
CountryCode::Cg => { /* ... */ },
CountryCode::Ch => { /* ... */ },
CountryCode::Ci => { /* ... */ },
CountryCode::Ck => { /* ... */ },
CountryCode::Cl => { /* ... */ },
CountryCode::Cm => { /* ... */ },
CountryCode::Cn => { /* ... */ },
CountryCode::Co => { /* ... */ },
CountryCode::Cr => { /* ... */ },
CountryCode::Cu => { /* ... */ },
CountryCode::Cv => { /* ... */ },
CountryCode::Cw => { /* ... */ },
CountryCode::Cx => { /* ... */ },
CountryCode::Cy => { /* ... */ },
CountryCode::Cz => { /* ... */ },
CountryCode::De => { /* ... */ },
CountryCode::Dj => { /* ... */ },
CountryCode::Dk => { /* ... */ },
CountryCode::Dm => { /* ... */ },
CountryCode::Do => { /* ... */ },
CountryCode::Dz => { /* ... */ },
CountryCode::Ec => { /* ... */ },
CountryCode::Ee => { /* ... */ },
CountryCode::Eg => { /* ... */ },
CountryCode::Eh => { /* ... */ },
CountryCode::Er => { /* ... */ },
CountryCode::Es => { /* ... */ },
CountryCode::Et => { /* ... */ },
CountryCode::Fi => { /* ... */ },
CountryCode::Fj => { /* ... */ },
CountryCode::Fk => { /* ... */ },
CountryCode::Fm => { /* ... */ },
CountryCode::Fo => { /* ... */ },
CountryCode::Fr => { /* ... */ },
CountryCode::Ga => { /* ... */ },
CountryCode::Gb => { /* ... */ },
CountryCode::Gd => { /* ... */ },
CountryCode::Ge => { /* ... */ },
CountryCode::Gf => { /* ... */ },
CountryCode::Gg => { /* ... */ },
CountryCode::Gh => { /* ... */ },
CountryCode::Gi => { /* ... */ },
CountryCode::Gl => { /* ... */ },
CountryCode::Gm => { /* ... */ },
CountryCode::Gn => { /* ... */ },
CountryCode::Gp => { /* ... */ },
CountryCode::Gq => { /* ... */ },
CountryCode::Gr => { /* ... */ },
CountryCode::Gs => { /* ... */ },
CountryCode::Gt => { /* ... */ },
CountryCode::Gu => { /* ... */ },
CountryCode::Gw => { /* ... */ },
CountryCode::Gy => { /* ... */ },
CountryCode::Hk => { /* ... */ },
CountryCode::Hm => { /* ... */ },
CountryCode::Hn => { /* ... */ },
CountryCode::Hr => { /* ... */ },
CountryCode::Ht => { /* ... */ },
CountryCode::Hu => { /* ... */ },
CountryCode::Id => { /* ... */ },
CountryCode::Ie => { /* ... */ },
CountryCode::Il => { /* ... */ },
CountryCode::Im => { /* ... */ },
CountryCode::In => { /* ... */ },
CountryCode::Io => { /* ... */ },
CountryCode::Iq => { /* ... */ },
CountryCode::Ir => { /* ... */ },
CountryCode::Is => { /* ... */ },
CountryCode::It => { /* ... */ },
CountryCode::Je => { /* ... */ },
CountryCode::Jm => { /* ... */ },
CountryCode::Jo => { /* ... */ },
CountryCode::Jp => { /* ... */ },
CountryCode::Ke => { /* ... */ },
CountryCode::Kg => { /* ... */ },
CountryCode::Kh => { /* ... */ },
CountryCode::Ki => { /* ... */ },
CountryCode::Km => { /* ... */ },
CountryCode::Kn => { /* ... */ },
CountryCode::Kp => { /* ... */ },
CountryCode::Kr => { /* ... */ },
CountryCode::Kw => { /* ... */ },
CountryCode::Ky => { /* ... */ },
CountryCode::Kz => { /* ... */ },
CountryCode::La => { /* ... */ },
CountryCode::Lb => { /* ... */ },
CountryCode::Lc => { /* ... */ },
CountryCode::Li => { /* ... */ },
CountryCode::Lk => { /* ... */ },
CountryCode::Lr => { /* ... */ },
CountryCode::Ls => { /* ... */ },
CountryCode::Lt => { /* ... */ },
CountryCode::Lu => { /* ... */ },
CountryCode::Lv => { /* ... */ },
CountryCode::Ly => { /* ... */ },
CountryCode::Ma => { /* ... */ },
CountryCode::Mc => { /* ... */ },
CountryCode::Md => { /* ... */ },
CountryCode::Me => { /* ... */ },
CountryCode::Mf => { /* ... */ },
CountryCode::Mg => { /* ... */ },
CountryCode::Mh => { /* ... */ },
CountryCode::Mk => { /* ... */ },
CountryCode::Ml => { /* ... */ },
CountryCode::Mm => { /* ... */ },
CountryCode::Mn => { /* ... */ },
CountryCode::Mo => { /* ... */ },
CountryCode::Mp => { /* ... */ },
CountryCode::Mq => { /* ... */ },
CountryCode::Mr => { /* ... */ },
CountryCode::Ms => { /* ... */ },
CountryCode::Mt => { /* ... */ },
CountryCode::Mu => { /* ... */ },
CountryCode::Mv => { /* ... */ },
CountryCode::Mw => { /* ... */ },
CountryCode::Mx => { /* ... */ },
CountryCode::My => { /* ... */ },
CountryCode::Mz => { /* ... */ },
CountryCode::Na => { /* ... */ },
CountryCode::Nc => { /* ... */ },
CountryCode::Ne => { /* ... */ },
CountryCode::Nf => { /* ... */ },
CountryCode::Ng => { /* ... */ },
CountryCode::Ni => { /* ... */ },
CountryCode::Nl => { /* ... */ },
CountryCode::No => { /* ... */ },
CountryCode::Np => { /* ... */ },
CountryCode::Nr => { /* ... */ },
CountryCode::Nu => { /* ... */ },
CountryCode::Nz => { /* ... */ },
CountryCode::Om => { /* ... */ },
CountryCode::Pa => { /* ... */ },
CountryCode::Pe => { /* ... */ },
CountryCode::Pf => { /* ... */ },
CountryCode::Pg => { /* ... */ },
CountryCode::Ph => { /* ... */ },
CountryCode::Pk => { /* ... */ },
CountryCode::Pl => { /* ... */ },
CountryCode::Pm => { /* ... */ },
CountryCode::Pn => { /* ... */ },
CountryCode::Pr => { /* ... */ },
CountryCode::Ps => { /* ... */ },
CountryCode::Pt => { /* ... */ },
CountryCode::Pw => { /* ... */ },
CountryCode::Py => { /* ... */ },
CountryCode::Qa => { /* ... */ },
CountryCode::Re => { /* ... */ },
CountryCode::Ro => { /* ... */ },
CountryCode::Rs => { /* ... */ },
CountryCode::Ru => { /* ... */ },
CountryCode::Rw => { /* ... */ },
CountryCode::Sa => { /* ... */ },
CountryCode::Sb => { /* ... */ },
CountryCode::Sc => { /* ... */ },
CountryCode::Sd => { /* ... */ },
CountryCode::Se => { /* ... */ },
CountryCode::Sg => { /* ... */ },
CountryCode::Sh => { /* ... */ },
CountryCode::Si => { /* ... */ },
CountryCode::Sj => { /* ... */ },
CountryCode::Sk => { /* ... */ },
CountryCode::Sl => { /* ... */ },
CountryCode::Sm => { /* ... */ },
CountryCode::Sn => { /* ... */ },
CountryCode::So => { /* ... */ },
CountryCode::Sr => { /* ... */ },
CountryCode::Ss => { /* ... */ },
CountryCode::St => { /* ... */ },
CountryCode::Sv => { /* ... */ },
CountryCode::Sx => { /* ... */ },
CountryCode::Sy => { /* ... */ },
CountryCode::Sz => { /* ... */ },
CountryCode::Tc => { /* ... */ },
CountryCode::Td => { /* ... */ },
CountryCode::Tf => { /* ... */ },
CountryCode::Tg => { /* ... */ },
CountryCode::Th => { /* ... */ },
CountryCode::Tj => { /* ... */ },
CountryCode::Tk => { /* ... */ },
CountryCode::Tl => { /* ... */ },
CountryCode::Tm => { /* ... */ },
CountryCode::Tn => { /* ... */ },
CountryCode::To => { /* ... */ },
CountryCode::Tr => { /* ... */ },
CountryCode::Tt => { /* ... */ },
CountryCode::Tv => { /* ... */ },
CountryCode::Tw => { /* ... */ },
CountryCode::Tz => { /* ... */ },
CountryCode::Ua => { /* ... */ },
CountryCode::Ug => { /* ... */ },
CountryCode::Um => { /* ... */ },
CountryCode::Us => { /* ... */ },
CountryCode::Uy => { /* ... */ },
CountryCode::Uz => { /* ... */ },
CountryCode::Va => { /* ... */ },
CountryCode::Vc => { /* ... */ },
CountryCode::Ve => { /* ... */ },
CountryCode::Vg => { /* ... */ },
CountryCode::Vi => { /* ... */ },
CountryCode::Vn => { /* ... */ },
CountryCode::Vu => { /* ... */ },
CountryCode::Wf => { /* ... */ },
CountryCode::Ws => { /* ... */ },
CountryCode::Xk => { /* ... */ },
CountryCode::Ye => { /* ... */ },
CountryCode::Yt => { /* ... */ },
CountryCode::Za => { /* ... */ },
CountryCode::Zm => { /* ... */ },
CountryCode::Zw => { /* ... */ },
other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
_ => { /* ... */ },
}
The above code demonstrates that when countrycode
represents
NewFeature
, the execution path will lead to the second last match arm,
even though the enum does not contain a variant CountryCode::NewFeature
in the current version of SDK. The reason is that the variable other
,
created by the @
operator, is bound to
CountryCode::Unknown(UnknownVariantValue("NewFeature".to_owned()))
and calling as_str
on it yields "NewFeature"
.
This match expression is forward-compatible when executed with a newer
version of SDK where the variant CountryCode::NewFeature
is defined.
Specifically, when countrycode
represents NewFeature
,
the execution path will hit the second last match arm as before by virtue of
calling as_str
on CountryCode::NewFeature
also yielding "NewFeature"
.
Explicitly matching on the Unknown
variant should
be avoided for two reasons:
- The inner data
UnknownVariantValue
is opaque, and no further information can be extracted. - It might inadvertently shadow other intended match arms.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Ad
Ae
Af
Ag
Ai
Al
Am
Ao
Aq
Ar
As
At
Au
Aw
Ax
Az
Ba
Bb
Bd
Be
Bf
Bg
Bh
Bi
Bj
Bl
Bm
Bn
Bo
Bq
Br
Bs
Bt
Bv
Bw
By
Bz
Ca
Cc
Cd
Cf
Cg
Ch
Ci
Ck
Cl
Cm
Cn
Co
Cr
Cu
Cv
Cw
Cx
Cy
Cz
De
Dj
Dk
Dm
Do
Dz
Ec
Ee
Eg
Eh
Er
Es
Et
Fi
Fj
Fk
Fm
Fo
Fr
Ga
Gb
Gd
Ge
Gf
Gg
Gh
Gi
Gl
Gm
Gn
Gp
Gq
Gr
Gs
Gt
Gu
Gw
Gy
Hk
Hm
Hn
Hr
Ht
Hu
Id
Ie
Il
Im
In
Io
Iq
Ir
Is
It
Je
Jm
Jo
Jp
Ke
Kg
Kh
Ki
Km
Kn
Kp
Kr
Kw
Ky
Kz
La
Lb
Lc
Li
Lk
Lr
Ls
Lt
Lu
Lv
Ly
Ma
Mc
Md
Me
Mf
Mg
Mh
Mk
Ml
Mm
Mn
Mo
Mp
Mq
Mr
Ms
Mt
Mu
Mv
Mw
Mx
My
Mz
Na
Nc
Ne
Nf
Ng
Ni
Nl
No
Np
Nr
Nu
Nz
Om
Pa
Pe
Pf
Pg
Ph
Pk
Pl
Pm
Pn
Pr
Ps
Pt
Pw
Py
Qa
Re
Ro
Rs
Ru
Rw
Sa
Sb
Sc
Sd
Se
Sg
Sh
Si
Sj
Sk
Sl
Sm
Sn
So
Sr
Ss
St
Sv
Sx
Sy
Sz
Tc
Td
Tf
Tg
Th
Tj
Tk
Tl
Tm
Tn
To
Tr
Tt
Tv
Tw
Tz
Ua
Ug
Um
Us
Uy
Uz
Va
Vc
Ve
Vg
Vi
Vn
Vu
Wf
Ws
Xk
Ye
Yt
Za
Zm
Zw
Unknown(UnknownVariantValue)
Unknown
. See the docs on this enum for the correct way to handle unknown variants.Unknown
contains new variants that have been added since this code was generated.
Implementations§
Source§impl CountryCode
impl CountryCode
Source§impl CountryCode
impl CountryCode
Sourcepub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
pub fn try_parse(value: &str) -> Result<Self, UnknownVariantError>
Parses the enum value while disallowing unknown variants.
Unknown variants will result in an error.
Trait Implementations§
Source§impl AsRef<str> for CountryCode
impl AsRef<str> for CountryCode
Source§impl Clone for CountryCode
impl Clone for CountryCode
Source§fn clone(&self) -> CountryCode
fn clone(&self) -> CountryCode
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CountryCode
impl Debug for CountryCode
Source§impl Display for CountryCode
impl Display for CountryCode
Source§impl From<&str> for CountryCode
impl From<&str> for CountryCode
Source§impl FromStr for CountryCode
impl FromStr for CountryCode
Source§impl Hash for CountryCode
impl Hash for CountryCode
Source§impl Ord for CountryCode
impl Ord for CountryCode
Source§fn cmp(&self, other: &CountryCode) -> Ordering
fn cmp(&self, other: &CountryCode) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for CountryCode
impl PartialEq for CountryCode
Source§impl PartialOrd for CountryCode
impl PartialOrd for CountryCode
impl Eq for CountryCode
impl StructuralPartialEq for CountryCode
Auto Trait Implementations§
impl Freeze for CountryCode
impl RefUnwindSafe for CountryCode
impl Send for CountryCode
impl Sync for CountryCode
impl Unpin for CountryCode
impl UnwindSafe for CountryCode
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.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>
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>
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);