reth::core::primitives::revm_primitives::alloy_primitives::ruint

Struct Bits

pub struct Bits<const BITS: usize, const LIMBS: usize>(/* private fields */);
Expand description

A newtype wrapper around Uint that restricts operations to those relevant for bit arrays.

Implementations§

§

impl<const BITS: usize, const LIMBS: usize> Bits<BITS, LIMBS>

pub const LIMBS: usize = Uint<BITS, LIMBS>::LIMBS

The size of this integer type in 64-bit limbs.

pub const BITS: usize = Uint<BITS, LIMBS>::BITS

The size of this integer type in bits.

pub const BYTES: usize = Uint<BITS, LIMBS>::BYTES

The size of this integer type in bits.

pub const ZERO: Bits<BITS, LIMBS> = _

The value zero. This is the only value that exists in all Uint types.

pub const fn into_inner(self) -> Uint<BITS, LIMBS>

Returns the inner Uint.

pub const fn as_uint(&self) -> &Uint<BITS, LIMBS>

Returns a reference to the inner Uint.

pub fn as_uint_mut(&mut self) -> &mut Uint<BITS, LIMBS>

Returns a mutable reference to the inner Uint.

§

impl<const BITS: usize, const LIMBS: usize> Bits<BITS, LIMBS>

pub fn reverse_bits(self) -> Bits<BITS, LIMBS>

See Uint::reverse_bits for documentation.

pub fn as_le_bytes(&self) -> Cow<'_, [u8]>

See Uint::as_le_bytes for documentation.

pub fn to_be_bytes_vec(&self) -> Vec<u8> ⓘ

See Uint::to_be_bytes_vec for documentation.

pub fn to_le_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

See Uint::to_le_bytes for documentation.

pub fn to_be_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

See Uint::to_be_bytes for documentation.

pub fn leading_zeros(&self) -> usize

See Uint::leading_zeros for documentation.

pub fn leading_ones(&self) -> usize

See Uint::leading_ones for documentation.

pub fn trailing_zeros(&self) -> usize

See Uint::trailing_zeros for documentation.

pub fn trailing_ones(&self) -> usize

See Uint::trailing_ones for documentation.

pub unsafe fn as_limbs_mut(&mut self) -> &mut [u64; LIMBS]

See Uint::as_limbs_mut for documentation.

pub fn checked_shl(self, rhs: usize) -> Option<Bits<BITS, LIMBS>>

See Uint::checked_shl for documentation.

pub fn checked_shr(self, rhs: usize) -> Option<Bits<BITS, LIMBS>>

See Uint::checked_shr for documentation.

pub fn overflowing_shl(self, rhs: usize) -> (Bits<BITS, LIMBS>, bool)

See Uint::overflowing_shl for documentation.

pub fn overflowing_shr(self, rhs: usize) -> (Bits<BITS, LIMBS>, bool)

See Uint::overflowing_shr for documentation.

pub fn wrapping_shl(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::wrapping_shl for documentation.

pub fn wrapping_shr(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::wrapping_shr for documentation.

pub fn rotate_left(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::rotate_left for documentation.

pub fn rotate_right(self, rhs: usize) -> Bits<BITS, LIMBS>

See Uint::rotate_right for documentation.

pub fn try_from_be_slice(bytes: &[u8]) -> Option<Bits<BITS, LIMBS>>

See Uint::try_from_be_slice for documentation.

pub fn try_from_le_slice(bytes: &[u8]) -> Option<Bits<BITS, LIMBS>>

See Uint::try_from_le_slice for documentation.

pub fn from_str_radix( src: &str, radix: u64, ) -> Result<Bits<BITS, LIMBS>, ParseError>

See Uint::from_str_radix for documentation.

pub fn from_be_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Bits<BITS, LIMBS>

See Uint::from_be_bytes for documentation.

pub fn from_le_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Bits<BITS, LIMBS>

See Uint::from_le_bytes for documentation.

pub const fn from_limbs(limbs: [u64; LIMBS]) -> Bits<BITS, LIMBS>

See Uint::from_limbs for documentation.

pub const fn as_limbs(&self) -> &[u64; LIMBS]

See Uint::as_limbs for documentation.

Trait Implementations§

§

impl<const BITS: usize, const LIMBS: usize> Arbitrary for Bits<BITS, LIMBS>

§

type Parameters = <Uint<BITS, LIMBS> as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.
§

type Strategy = Map<<Uint<BITS, LIMBS> as Arbitrary>::Strategy, fn(_: Uint<BITS, LIMBS>) -> Bits<BITS, LIMBS>>

The type of Strategy used to generate values of type Self.
§

fn arbitrary_with( args: <Bits<BITS, LIMBS> as Arbitrary>::Parameters, ) -> <Bits<BITS, LIMBS> as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more
§

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). Read more
§

impl<const BITS: usize, const LIMBS: usize> BitAnd<&Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.
§

fn bitand( self, rhs: &Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitAnd<&Bits<BITS, LIMBS>>>::Output

Performs the & operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitAnd<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.
§

fn bitand( self, rhs: &Bits<BITS, LIMBS>, ) -> <Bits<BITS, LIMBS> as BitAnd<&Bits<BITS, LIMBS>>>::Output

Performs the & operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitAnd<Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.
§

fn bitand( self, rhs: Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitAnd<Bits<BITS, LIMBS>>>::Output

Performs the & operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitAnd for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the & operator.
§

fn bitand(self, rhs: Bits<BITS, LIMBS>) -> <Bits<BITS, LIMBS> as BitAnd>::Output

Performs the & operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitAndAssign<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

§

fn bitand_assign(&mut self, rhs: &Bits<BITS, LIMBS>)

Performs the &= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitAndAssign for Bits<BITS, LIMBS>

§

fn bitand_assign(&mut self, rhs: Bits<BITS, LIMBS>)

Performs the &= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitOr<&Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.
§

fn bitor( self, rhs: &Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitOr<&Bits<BITS, LIMBS>>>::Output

Performs the | operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitOr<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.
§

fn bitor( self, rhs: &Bits<BITS, LIMBS>, ) -> <Bits<BITS, LIMBS> as BitOr<&Bits<BITS, LIMBS>>>::Output

Performs the | operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitOr<Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.
§

fn bitor( self, rhs: Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitOr<Bits<BITS, LIMBS>>>::Output

Performs the | operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitOr for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the | operator.
§

fn bitor(self, rhs: Bits<BITS, LIMBS>) -> <Bits<BITS, LIMBS> as BitOr>::Output

Performs the | operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitOrAssign<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

§

fn bitor_assign(&mut self, rhs: &Bits<BITS, LIMBS>)

Performs the |= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitOrAssign for Bits<BITS, LIMBS>

§

fn bitor_assign(&mut self, rhs: Bits<BITS, LIMBS>)

Performs the |= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitXor<&Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.
§

fn bitxor( self, rhs: &Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitXor<&Bits<BITS, LIMBS>>>::Output

Performs the ^ operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitXor<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.
§

fn bitxor( self, rhs: &Bits<BITS, LIMBS>, ) -> <Bits<BITS, LIMBS> as BitXor<&Bits<BITS, LIMBS>>>::Output

Performs the ^ operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitXor<Bits<BITS, LIMBS>> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.
§

fn bitxor( self, rhs: Bits<BITS, LIMBS>, ) -> <&Bits<BITS, LIMBS> as BitXor<Bits<BITS, LIMBS>>>::Output

Performs the ^ operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitXor for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ^ operator.
§

fn bitxor(self, rhs: Bits<BITS, LIMBS>) -> <Bits<BITS, LIMBS> as BitXor>::Output

Performs the ^ operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitXorAssign<&Bits<BITS, LIMBS>> for Bits<BITS, LIMBS>

§

fn bitxor_assign(&mut self, rhs: &Bits<BITS, LIMBS>)

Performs the ^= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> BitXorAssign for Bits<BITS, LIMBS>

§

fn bitxor_assign(&mut self, rhs: Bits<BITS, LIMBS>)

Performs the ^= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Clone for Bits<BITS, LIMBS>

§

fn clone(&self) -> Bits<BITS, LIMBS>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<const BITS: usize, const LIMBS: usize> Debug for Bits<BITS, LIMBS>

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
§

impl<const BITS: usize, const LIMBS: usize> Default for Bits<BITS, LIMBS>

§

fn default() -> Bits<BITS, LIMBS>

Returns the “default value” for a type. Read more
§

impl<'de, const BITS: usize, const LIMBS: usize> Deserialize<'de> for Bits<BITS, LIMBS>

§

fn deserialize<D>( deserializer: D, ) -> Result<Bits<BITS, LIMBS>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl<const BITS: usize, const LIMBS: usize> From<Bits<BITS, LIMBS>> for Uint<BITS, LIMBS>

§

fn from(value: Bits<BITS, LIMBS>) -> Uint<BITS, LIMBS>

Converts to this type from the input type.
§

impl<const BITS: usize, const LIMBS: usize> From<Uint<BITS, LIMBS>> for Bits<BITS, LIMBS>

§

fn from(value: Uint<BITS, LIMBS>) -> Bits<BITS, LIMBS>

Converts to this type from the input type.
§

impl<const BITS: usize, const LIMBS: usize> FromStr for Bits<BITS, LIMBS>

§

type Err = <Uint<BITS, LIMBS> as FromStr>::Err

The associated error which can be returned from parsing.
§

fn from_str( src: &str, ) -> Result<Bits<BITS, LIMBS>, <Bits<BITS, LIMBS> as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

impl<const BITS: usize, const LIMBS: usize> Hash for Bits<BITS, LIMBS>

§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl<const BITS: usize, const LIMBS: usize> Index<usize> for Bits<BITS, LIMBS>

§

type Output = bool

The returned type after indexing.
§

fn index(&self, index: usize) -> &<Bits<BITS, LIMBS> as Index<usize>>::Output

Performs the indexing (container[index]) operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Not for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ! operator.
§

fn not(self) -> Bits<BITS, LIMBS>

Performs the unary ! operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Not for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the ! operator.
§

fn not(self) -> Bits<BITS, LIMBS>

Performs the unary ! operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> PartialEq for Bits<BITS, LIMBS>

§

fn eq(&self, other: &Bits<BITS, LIMBS>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<const BITS: usize, const LIMBS: usize> Serialize for Bits<BITS, LIMBS>

§

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shl<&usize> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.
§

fn shl(self, rhs: &usize) -> <&Bits<BITS, LIMBS> as Shl<&usize>>::Output

Performs the << operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shl<&usize> for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.
§

fn shl(self, rhs: &usize) -> Bits<BITS, LIMBS>

Performs the << operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shl<usize> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.
§

fn shl(self, rhs: usize) -> <&Bits<BITS, LIMBS> as Shl<usize>>::Output

Performs the << operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shl<usize> for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the << operator.
§

fn shl(self, rhs: usize) -> Bits<BITS, LIMBS>

Performs the << operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> ShlAssign<&usize> for Bits<BITS, LIMBS>

§

fn shl_assign(&mut self, rhs: &usize)

Performs the <<= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> ShlAssign<usize> for Bits<BITS, LIMBS>

§

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shr<&usize> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.
§

fn shr(self, rhs: &usize) -> <&Bits<BITS, LIMBS> as Shr<&usize>>::Output

Performs the >> operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shr<&usize> for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.
§

fn shr(self, rhs: &usize) -> Bits<BITS, LIMBS>

Performs the >> operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shr<usize> for &Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.
§

fn shr(self, rhs: usize) -> <&Bits<BITS, LIMBS> as Shr<usize>>::Output

Performs the >> operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Shr<usize> for Bits<BITS, LIMBS>

§

type Output = Bits<BITS, LIMBS>

The resulting type after applying the >> operator.
§

fn shr(self, rhs: usize) -> Bits<BITS, LIMBS>

Performs the >> operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> ShrAssign<&usize> for Bits<BITS, LIMBS>

§

fn shr_assign(&mut self, rhs: &usize)

Performs the >>= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> ShrAssign<usize> for Bits<BITS, LIMBS>

§

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation. Read more
§

impl<const BITS: usize, const LIMBS: usize> Copy for Bits<BITS, LIMBS>

§

impl<const BITS: usize, const LIMBS: usize> Eq for Bits<BITS, LIMBS>

§

impl<const BITS: usize, const LIMBS: usize> StructuralPartialEq for Bits<BITS, LIMBS>

Auto Trait Implementations§

§

impl<const BITS: usize, const LIMBS: usize> Freeze for Bits<BITS, LIMBS>

§

impl<const BITS: usize, const LIMBS: usize> RefUnwindSafe for Bits<BITS, LIMBS>

§

impl<const BITS: usize, const LIMBS: usize> Send for Bits<BITS, LIMBS>

§

impl<const BITS: usize, const LIMBS: usize> Sync for Bits<BITS, LIMBS>

§

impl<const BITS: usize, const LIMBS: usize> Unpin for Bits<BITS, LIMBS>

§

impl<const BITS: usize, const LIMBS: usize> UnwindSafe for Bits<BITS, LIMBS>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

impl<T> Paint for T
where T: ?Sized,

§

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();
§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Primary].

§Example
println!("{}", value.primary());
§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color::Fixed].

§Example
println!("{}", value.fixed(color));
§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color::Rgb].

§Example
println!("{}", value.rgb(r, g, b));
§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Black].

§Example
println!("{}", value.black());
§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Red].

§Example
println!("{}", value.red());
§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Green].

§Example
println!("{}", value.green());
§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Yellow].

§Example
println!("{}", value.yellow());
§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Blue].

§Example
println!("{}", value.blue());
§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Magenta].

§Example
println!("{}", value.magenta());
§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Cyan].

§Example
println!("{}", value.cyan());
§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color::White].

§Example
println!("{}", value.white());
§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightBlack].

§Example
println!("{}", value.bright_black());
§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightRed].

§Example
println!("{}", value.bright_red());
§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightGreen].

§Example
println!("{}", value.bright_green());
§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightYellow].

§Example
println!("{}", value.bright_yellow());
§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightBlue].

§Example
println!("{}", value.bright_blue());
§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightMagenta].

§Example
println!("{}", value.bright_magenta());
§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightCyan].

§Example
println!("{}", value.bright_cyan());
§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightWhite].

§Example
println!("{}", value.bright_white());
§

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();
§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Primary].

§Example
println!("{}", value.on_primary());
§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color::Fixed].

§Example
println!("{}", value.on_fixed(color));
§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color::Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Black].

§Example
println!("{}", value.on_black());
§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Red].

§Example
println!("{}", value.on_red());
§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Green].

§Example
println!("{}", value.on_green());
§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Yellow].

§Example
println!("{}", value.on_yellow());
§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Blue].

§Example
println!("{}", value.on_blue());
§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Magenta].

§Example
println!("{}", value.on_magenta());
§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Cyan].

§Example
println!("{}", value.on_cyan());
§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color::White].

§Example
println!("{}", value.on_white());
§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightBlack].

§Example
println!("{}", value.on_bright_black());
§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightRed].

§Example
println!("{}", value.on_bright_red());
§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightGreen].

§Example
println!("{}", value.on_bright_green());
§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightBlue].

§Example
println!("{}", value.on_bright_blue());
§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightWhite].

§Example
println!("{}", value.on_bright_white());
§

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();
§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Bold].

§Example
println!("{}", value.bold());
§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Dim].

§Example
println!("{}", value.dim());
§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Italic].

§Example
println!("{}", value.italic());
§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute::Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute::RapidBlink].

§Example
println!("{}", value.rapid_blink());
§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Invert].

§Example
println!("{}", value.invert());
§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Conceal].

§Example
println!("{}", value.conceal());
§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Strike].

§Example
println!("{}", value.strike());
§

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();
§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Mask].

§Example
println!("{}", value.mask());
§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Wrap].

§Example
println!("{}", value.wrap());
§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Linger].

§Example
println!("{}", value.linger());
§

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.

Returns self with the quirk() set to [Quirk::Clear].

§Example
println!("{}", value.clear());
§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Resetting].

§Example
println!("{}", value.resetting());
§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Bright].

§Example
println!("{}", value.bright());
§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::OnBright].

§Example
println!("{}", value.on_bright());
§

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);
§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more
§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryClone for T
where T: Clone,

§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T

§

impl<T> NippyJarHeader for T
where T: Send + Sync + Serialize + for<'b> Deserialize<'b> + Debug + 'static,

§

impl<T> RpcObject for T
where T: RpcParam + RpcReturn,

§

impl<T> RpcParam for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,

§

impl<T> RpcReturn for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.