pub struct Uncased<'s> { /* private fields */ }
alloc
only.Expand description
An uncased (case-insensitive, case-preserving), owned or borrowed ASCII string.
Implementations§
§impl<'s> Uncased<'s>
impl<'s> Uncased<'s>
pub fn new<S>(string: S) -> Uncased<'s>where
S: Into<Cow<'s, str>>,
pub fn new<S>(string: S) -> Uncased<'s>where S: Into<Cow<'s, str>>,
Creates a new Uncased
string from string
without allocating.
Example
use uncased::Uncased;
let uncased = Uncased::new("Content-Type");
assert_eq!(uncased, "content-type");
assert_eq!(uncased, "CONTENT-Type");
pub const fn from_borrowed(string: &'s str) -> Uncased<'s>
pub const fn from_borrowed(string: &'s str) -> Uncased<'s>
Creates a new Uncased
string from a borrowed string
.
Example
use uncased::Uncased;
const UNCASED: Uncased = Uncased::from_borrowed("Content-Type");
assert_eq!(UNCASED, "content-type");
assert_eq!(UNCASED, "CONTENT-Type");
pub const fn from_owned(string: String) -> Uncased<'s>
pub const fn from_owned(string: String) -> Uncased<'s>
Creates a new Uncased
string from string
without allocating.
Example
use uncased::Uncased;
const UNCASED: Uncased = Uncased::from_owned(String::new());
let uncased = Uncased::from_owned("Content-Type".to_string());
assert_eq!(uncased, "content-type");
assert_eq!(uncased, "CONTENT-Type");
pub fn as_uncased_str(&self) -> &UncasedStr
pub fn as_uncased_str(&self) -> &UncasedStr
Converts self
into an owned Uncased<'static>
, allocating if
necessary.
Example
use uncased::Uncased;
let foo = "foo".to_string();
let uncased = Uncased::from(foo.as_str());
let owned: Uncased<'static> = uncased.into_owned();
assert_eq!(owned, "foo");
pub fn into_string(self) -> String
pub fn into_string(self) -> String
Converts self
into an owned String
, allocating if necessary.
Example
use uncased::Uncased;
let uncased = Uncased::new("Content-Type");
let string = uncased.into_string();
assert_eq!(string, "Content-Type".to_string());
pub fn into_owned(self) -> Uncased<'static>
pub fn into_owned(self) -> Uncased<'static>
Converts self
into an owned Uncased<'static>
, allocating if
necessary.
Example
use uncased::Uncased;
let foo = "foo".to_string();
let uncased = Uncased::from(foo.as_str());
let owned: Uncased<'static> = uncased.into_owned();
assert_eq!(owned, "foo");
pub fn into_boxed_uncased(self) -> Box<UncasedStr, Global>
pub fn into_boxed_uncased(self) -> Box<UncasedStr, Global>
Converts self
into a Box<UncasedStr>
.
Example
use uncased::Uncased;
let boxed = Uncased::new("Content-Type").into_boxed_uncased();
assert_eq!(&*boxed, "content-type");
Methods from Deref<Target = UncasedStr>§
pub fn as_str(&self) -> &str
pub fn as_str(&self) -> &str
Returns self
as an &str
.
Example
use uncased::UncasedStr;
let uncased_str = UncasedStr::new("Hello!");
assert_eq!(uncased_str.as_str(), "Hello!");
assert_ne!(uncased_str.as_str(), "hELLo!");
pub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the length, in bytes, of self
.
Example
use uncased::UncasedStr;
let uncased_str = UncasedStr::new("Hello!");
assert_eq!(uncased_str.len(), 6);
pub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true
if self
has a length of zero bytes.
Examples
use uncased::UncasedStr;
let s = UncasedStr::new("");
assert!(s.is_empty());
let s = UncasedStr::new("not empty");
assert!(!s.is_empty());
pub fn starts_with(&self, string: &str) -> bool
pub fn starts_with(&self, string: &str) -> bool
Returns true
if self
starts with any casing of the string string
;
otherwise, returns false
.
Example
use uncased::UncasedStr;
let uncased_str = UncasedStr::new("MoOO");
assert!(uncased_str.starts_with("moo"));
assert!(uncased_str.starts_with("MOO"));
assert!(uncased_str.starts_with("MOOO"));
assert!(!uncased_str.starts_with("boo"));
let uncased_str = UncasedStr::new("Bèe");
assert!(!uncased_str.starts_with("Be"));
assert!(uncased_str.starts_with("Bè"));
assert!(uncased_str.starts_with("Bè"));
assert!(uncased_str.starts_with("bèe"));
assert!(uncased_str.starts_with("BèE"));
Trait Implementations§
§impl AsRef<UncasedStr> for Uncased<'_>
impl AsRef<UncasedStr> for Uncased<'_>
§fn as_ref(&self) -> &UncasedStr
fn as_ref(&self) -> &UncasedStr
§impl Borrow<UncasedStr> for Uncased<'_>
impl Borrow<UncasedStr> for Uncased<'_>
§fn borrow(&self) -> &UncasedStr
fn borrow(&self) -> &UncasedStr
§impl Deref for Uncased<'_>
impl Deref for Uncased<'_>
§type Target = UncasedStr
type Target = UncasedStr
§fn deref(&self) -> &UncasedStr
fn deref(&self) -> &UncasedStr
§impl<'a, 'de> Deserialize<'de> for Uncased<'a>
impl<'a, 'de> Deserialize<'de> for Uncased<'a>
§fn deserialize<D>(
deserializer: D
) -> Result<Uncased<'a>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>( deserializer: D ) -> Result<Uncased<'a>, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,
§impl<'s, 'c> From<&'c UncasedStr> for Uncased<'s>where
'c: 's,
impl<'s, 'c> From<&'c UncasedStr> for Uncased<'s>where 'c: 's,
§fn from(string: &'c UncasedStr) -> Uncased<'s>
fn from(string: &'c UncasedStr) -> Uncased<'s>
§impl Ord for Uncased<'_>
impl Ord for Uncased<'_>
§impl PartialEq<&Uncased<'_>> for String
impl PartialEq<&Uncased<'_>> for String
§impl PartialEq<&Uncased<'_>> for UncasedStr
impl PartialEq<&Uncased<'_>> for UncasedStr
§impl PartialEq<&UncasedStr> for Uncased<'_>
impl PartialEq<&UncasedStr> for Uncased<'_>
§fn eq(&self, other: &&UncasedStr) -> bool
fn eq(&self, other: &&UncasedStr) -> bool
self
and other
values to be equal, and is used
by ==
.§impl PartialEq<Uncased<'_>> for &UncasedStr
impl PartialEq<Uncased<'_>> for &UncasedStr
§impl PartialEq<Uncased<'_>> for &str
impl PartialEq<Uncased<'_>> for &str
§impl PartialEq<Uncased<'_>> for String
impl PartialEq<Uncased<'_>> for String
§impl PartialEq<Uncased<'_>> for Uncased<'_>
impl PartialEq<Uncased<'_>> for Uncased<'_>
§impl PartialEq<Uncased<'_>> for UncasedStr
impl PartialEq<Uncased<'_>> for UncasedStr
§impl PartialEq<Uncased<'_>> for str
impl PartialEq<Uncased<'_>> for str
§impl PartialEq<UncasedStr> for &Uncased<'_>
impl PartialEq<UncasedStr> for &Uncased<'_>
§fn eq(&self, other: &UncasedStr) -> bool
fn eq(&self, other: &UncasedStr) -> bool
self
and other
values to be equal, and is used
by ==
.§impl PartialEq<UncasedStr> for Uncased<'_>
impl PartialEq<UncasedStr> for Uncased<'_>
§fn eq(&self, other: &UncasedStr) -> bool
fn eq(&self, other: &UncasedStr) -> bool
self
and other
values to be equal, and is used
by ==
.§impl PartialOrd<&Uncased<'_>> for String
impl PartialOrd<&Uncased<'_>> for String
§fn partial_cmp(&self, other: &&Uncased<'_>) -> Option<Ordering>
fn partial_cmp(&self, other: &&Uncased<'_>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<&Uncased<'_>> for UncasedStr
impl PartialOrd<&Uncased<'_>> for UncasedStr
§fn partial_cmp(&self, other: &&Uncased<'_>) -> Option<Ordering>
fn partial_cmp(&self, other: &&Uncased<'_>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<&UncasedStr> for Uncased<'_>
impl PartialOrd<&UncasedStr> for Uncased<'_>
§fn partial_cmp(&self, other: &&UncasedStr) -> Option<Ordering>
fn partial_cmp(&self, other: &&UncasedStr) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<String> for &Uncased<'_>
impl PartialOrd<String> for &Uncased<'_>
§fn partial_cmp(&self, other: &String) -> Option<Ordering>
fn partial_cmp(&self, other: &String) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<String> for Uncased<'_>
impl PartialOrd<String> for Uncased<'_>
§fn partial_cmp(&self, other: &String) -> Option<Ordering>
fn partial_cmp(&self, other: &String) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<Uncased<'_>> for &UncasedStr
impl PartialOrd<Uncased<'_>> for &UncasedStr
§fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<Uncased<'_>> for String
impl PartialOrd<Uncased<'_>> for String
§fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<Uncased<'_>> for Uncased<'_>
impl PartialOrd<Uncased<'_>> for Uncased<'_>
§fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<Uncased<'_>> for UncasedStr
impl PartialOrd<Uncased<'_>> for UncasedStr
§fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<Uncased<'_>> for str
impl PartialOrd<Uncased<'_>> for str
§fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
fn partial_cmp(&self, other: &Uncased<'_>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<UncasedStr> for &Uncased<'_>
impl PartialOrd<UncasedStr> for &Uncased<'_>
§fn partial_cmp(&self, other: &UncasedStr) -> Option<Ordering>
fn partial_cmp(&self, other: &UncasedStr) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<UncasedStr> for Uncased<'_>
impl PartialOrd<UncasedStr> for Uncased<'_>
§fn partial_cmp(&self, other: &UncasedStr) -> Option<Ordering>
fn partial_cmp(&self, other: &UncasedStr) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl PartialOrd<str> for Uncased<'_>
impl PartialOrd<str> for Uncased<'_>
§fn partial_cmp(&self, other: &str) -> Option<Ordering>
fn partial_cmp(&self, other: &str) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more§impl<'a> Serialize for Uncased<'a>
impl<'a> Serialize for Uncased<'a>
§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,
impl Eq for Uncased<'_>
Auto Trait Implementations§
impl<'s> RefUnwindSafe for Uncased<'s>
impl<'s> Send for Uncased<'s>
impl<'s> Sync for Uncased<'s>
impl<'s> Unpin for Uncased<'s>
impl<'s> UnwindSafe for Uncased<'s>
Blanket Implementations§
§impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,
impl<'a, T> AsTaggedExplicit<'a> for Twhere T: 'a,
§impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,
impl<'a, T> AsTaggedImplicit<'a> for Twhere T: 'a,
§impl<T> AsUncased for Twhere
T: AsRef<str> + ?Sized,
impl<T> AsUncased for Twhere T: AsRef<str> + ?Sized,
§fn as_uncased(&self) -> &UncasedStr
fn as_uncased(&self) -> &UncasedStr
self
to an UncasedStr
.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
§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
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>
§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
source§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>
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>
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 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);