Skip to main content

VarFloat

Struct VarFloat 

Source
pub struct VarFloat<const N: u32> { /* private fields */ }

Trait Implementations§

Source§

impl<const N: u32> Add for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Self) -> Self::Output

Performs the + operation. Read more
Source§

impl<const N: u32> Add<&VarFloat<N>> for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: &Self) -> Self::Output

Performs the + operation. Read more
Source§

impl<const N: u32> Add<&VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: &VarFloat<N>) -> Self::Output

Performs the + operation. Read more
Source§

impl<const N: u32> Add<VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: VarFloat<N>) -> Self::Output

Performs the + operation. Read more
Source§

impl<const N: u32> AddAssign for VarFloat<N>

Source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
Source§

impl<const N: u32> AddAssign<&VarFloat<N>> for VarFloat<N>

Source§

fn add_assign(&mut self, rhs: &Self)

Performs the += operation. Read more
Source§

impl<'__de, const N: u32, __Context> BorrowDecode<'__de, __Context> for VarFloat<N>

Source§

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.
Source§

impl<const N: u32> Clone for VarFloat<N>

Source§

fn clone(&self) -> VarFloat<N>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<const N: u32> Debug for VarFloat<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: u32, __Context> Decode<__Context> for VarFloat<N>

Source§

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.
Source§

impl<const N: u32> Default for VarFloat<N>

Source§

fn default() -> Self

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

impl<'de, const N: u32> Deserialize<'de> for VarFloat<N>

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

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

impl<const N: u32> Display for VarFloat<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: u32> Div for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the / operator.
Source§

fn div(self, rhs: Self) -> Self::Output

Performs the / operation. Read more
Source§

impl<const N: u32> Div<&VarFloat<N>> for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the / operator.
Source§

fn div(self, rhs: &Self) -> Self::Output

Performs the / operation. Read more
Source§

impl<const N: u32> Div<&VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the / operator.
Source§

fn div(self, rhs: &VarFloat<N>) -> Self::Output

Performs the / operation. Read more
Source§

impl<const N: u32> Div<VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the / operator.
Source§

fn div(self, rhs: VarFloat<N>) -> Self::Output

Performs the / operation. Read more
Source§

impl<const N: u32> DivAssign for VarFloat<N>

Source§

fn div_assign(&mut self, rhs: Self)

Performs the /= operation. Read more
Source§

impl<const N: u32> DivAssign<&VarFloat<N>> for VarFloat<N>

Source§

fn div_assign(&mut self, rhs: &Self)

Performs the /= operation. Read more
Source§

impl<const N: u32> Encode for VarFloat<N>

Source§

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.
Source§

impl<const N: u32> EvaluationDomain for VarFloat<N>

Source§

const FIXED_PRECISION: Option<u32>

The single supported binary precision for fixed-precision domains. Read more
Source§

fn resolve_function( tags: &[AtomView<'_>], info: &EvaluationInfo, ) -> Option<Box<dyn ExternalFunction<Self>>>

Resolve a function implementation for the given tags, if available for the type. If no implementation exists for the type, a conversion from a ‘larger’ type may be used instead.
Source§

fn try_from_complex_float(f: Complex<Float>) -> Result<Self, String>

Try to convert a Complex<Float> to the type.
Source§

impl<const N: u32> ExportNumber for VarFloat<N>

Source§

fn export(&self) -> String

Export the number as a string.
Source§

fn is_real(&self) -> bool

Check if the number is real.
Source§

fn to_complex_double(&self) -> Complex<f64>

Convert the number to a complex double.
§

fn export_wrapped(&self) -> String

Export the number wrapped in a C++ type T.
§

fn export_wrapped_with(&self, wrapper: &str) -> String

Export the number wrapped in a C++ type wrapper.
Source§

impl<const N: u32> FixedPrecision for VarFloat<N>

Source§

const BINARY_PRECISION: usize

The number of binary digits in the mantissa.
§

const DECIMAL_PRECISION: usize = _

The (rounded) number of decimal digits in the mantissa.
Source§

impl<const N: u32> FloatLike for VarFloat<N>

Source§

fn set_from(&mut self, other: &Self)

Set this value from another value. May reuse memory.
Source§

fn mul_add(&self, a: &Self, b: &Self) -> Self

Perform (self * a) + b.
Source§

fn is_fully_zero(&self) -> bool

Return true if the number is exactly equal to zero (in all components).
Source§

fn from_i64(&self, a: i64) -> Self

Source§

fn from_usize(&self, a: usize) -> Self

Source§

fn get_precision(&self) -> u32

Get the number of precise binary digits.
Source§

fn set_precision(&mut self, _precision: u32)

Set the working precision to precision binary digits. Types that loosely track their precision discard the tracked loss, whereas certified enclosures stay valid. The value is rounded when the precision is lowered. Types with a fixed precision ignore this call.
Source§

fn zero(&self) -> Self

Source§

fn one(&self) -> Self

Source§

fn new_zero() -> Self

Create a zero that should only be used as a temporary value, as for some types it may have wrong precision information.
Source§

fn inv(&self) -> Self

Source§

fn pow(&self, e: u64) -> Self

Source§

fn sample_unit<R: Rng + ?Sized>(&self, rng: &mut R) -> Self

Sample a point on the interval [0, 1].
Source§

fn neg(&self) -> Self

Source§

fn get_epsilon(&self) -> f64

Source§

fn fixed_precision(&self) -> bool

Return true iff the precision is fixed, or false if the precision is changed dynamically.
§

fn real_cmp(&self, _other: &Self) -> Option<Ordering>

Compare ordered scalar values. Non-scalar types may return None.
§

fn real_classify(&self) -> Option<FpCategory>

Classify a scalar float for exceptional-value handling. Return None for domains without a scalar floating-point classification, such as complex numbers, SIMD vectors, or exact types.
§

fn needs_rescaling(&self) -> bool

Request scaled arithmetic for zero, subnormal or non-finite intermediates. The default opts out of scalar range guards (for example for exact types or types with multiple independently scaled components).
§

fn nan(&self) -> Option<Self>

Construct a NaN, preserving this value’s precision and component shape. Returns None for exact types, such as rationals, that cannot represent NaN.
Source§

impl<const N: u32> From<&Fraction<IntegerRing>> for VarFloat<N>

Source§

fn from(x: &Rational) -> Self

Converts to this type from the input type.
Source§

impl<const N: u32> From<&VarFloat<N>> for Float

Source§

fn from(value: &VarFloat<N>) -> Self

Converts to this type from the input type.
Source§

impl<const N: u32> From<Float> for VarFloat<N>

Source§

fn from(x: Float) -> Self

Converts to this type from the input type.
Source§

impl<const N: u32> From<Float> for VarFloat<N>

Source§

fn from(value: SymbolicaFloat) -> Self

Converts to this type from the input type.
Source§

impl<const N: u32> From<VarFloat<N>> for Float

Source§

fn from(value: VarFloat<N>) -> Self

Converts to this type from the input type.
Source§

impl<const N: u32> FromStr for VarFloat<N>

Source§

type Err = ParseFloatError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl<const N: u32> LowerExp for VarFloat<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: u32> Mul for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation. Read more
Source§

impl<const N: u32> Mul<&VarFloat<N>> for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &Self) -> Self::Output

Performs the * operation. Read more
Source§

impl<const N: u32> Mul<&VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: &VarFloat<N>) -> Self::Output

Performs the * operation. Read more
Source§

impl<const N: u32> Mul<VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: VarFloat<N>) -> Self::Output

Performs the * operation. Read more
Source§

impl<const N: u32> MulAssign for VarFloat<N>

Source§

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation. Read more
Source§

impl<const N: u32> MulAssign<&VarFloat<N>> for VarFloat<N>

Source§

fn mul_assign(&mut self, rhs: &Self)

Performs the *= operation. Read more
Source§

impl<const N: u32> Neg for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

impl<const N: u32> Neg for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

impl<const N: u32> PartialEq for VarFloat<N>

Source§

fn eq(&self, other: &VarFloat<N>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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.
Source§

impl<const N: u32> PartialOrd for VarFloat<N>

Source§

fn partial_cmp(&self, other: &VarFloat<N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<const N: u32> R for VarFloat<N>

Source§

impl<const N: u32> Real for VarFloat<N>

Source§

fn i(&self) -> Option<Self>

The imaginary unit, if it exists.
Source§

fn conj(&self) -> Self

Source§

fn pi(&self) -> Self

The constant π, 3.1415926535…
Source§

fn e(&self) -> Self

Euler’s number, 2.7182818…
Source§

fn euler(&self) -> Self

The Euler-Mascheroni constant, 0.5772156649…
Source§

fn phi(&self) -> Self

The golden ratio, 1.6180339887…
Source§

fn atan2(&self, x: &Self) -> Self

Source§

fn powf(&self, e: &Self) -> Self

Source§

fn log(&self) -> Self

Source§

fn norm(&self) -> Self

Source§

fn sqrt(&self) -> Self

Source§

fn exp(&self) -> Self

Source§

fn sin(&self) -> Self

Source§

fn cos(&self) -> Self

Source§

fn tan(&self) -> Self

Source§

fn asin(&self) -> Self

Source§

fn acos(&self) -> Self

Source§

fn sinh(&self) -> Self

Source§

fn cosh(&self) -> Self

Source§

fn tanh(&self) -> Self

Source§

fn asinh(&self) -> Self

Source§

fn acosh(&self) -> Self

Source§

fn atanh(&self) -> Self

§

fn hypot(&self, other: &Self) -> Self

Magnitude of a pair, avoiding unnecessary overflow and underflow.
§

fn copy_sign(&self, sign: &Self) -> Self

Absolute value with the sign of sign, including signed zero where supported.
§

fn log1p(&self) -> Self

Compute log(1 + self), retaining small increments lost when adding one.
§

fn sech(&self) -> Self

Reciprocal hyperbolic cosine, without overflowing an intermediate cosh.
§

fn csch(&self) -> Self

Reciprocal hyperbolic sine, retaining accuracy near zero and at infinity.
Source§

impl<const N: u32> RealLike for VarFloat<N>

Source§

impl<const N: u32> RefOne for VarFloat<N>

Source§

fn ref_one(&self) -> Self

Source§

impl<const N: u32> RefZero for VarFloat<N>

Source§

fn ref_zero(&self) -> Self

Source§

impl<const N: u32> Rem<&VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the % operator.
Source§

fn rem(self, rhs: &VarFloat<N>) -> Self::Output

Performs the % operation. Read more
Source§

impl<const N: u32> Serialize for VarFloat<N>

Source§

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

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

impl<const N: u32> SingleFloat for VarFloat<N>

Source§

fn is_finite(&self) -> bool

Source§

fn is_one(&self) -> bool

Source§

fn is_zero(&self) -> bool

Source§

fn from_rational(&self, rat: &Rational) -> Self

Convert a rational to a float with the same precision as the current float.
Source§

impl<const N: u32> StructuralPartialEq for VarFloat<N>

Source§

impl<const N: u32> Sub for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation. Read more
Source§

impl<const N: u32> Sub<&VarFloat<N>> for VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: &Self) -> Self::Output

Performs the - operation. Read more
Source§

impl<const N: u32> Sub<&VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: &VarFloat<N>) -> Self::Output

Performs the - operation. Read more
Source§

impl<const N: u32> Sub<VarFloat<N>> for &VarFloat<N>

Source§

type Output = VarFloat<N>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: VarFloat<N>) -> Self::Output

Performs the - operation. Read more
Source§

impl<const N: u32> SubAssign for VarFloat<N>

Source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
Source§

impl<const N: u32> SubAssign<&VarFloat<N>> for VarFloat<N>

Source§

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation. Read more
Source§

impl<const N: u32> UpdateAndGetParams<VarFloat<N>> for ParamBuilder<f64>
where VarFloat<N>: FloatLike,

Source§

fn update_emr_and_get_params<'a>( &'a mut self, _cache: (bool, bool), sample: &MomentumSample<VarFloat<N>>, graph: &Graph, helicities: &[Helicity], additional_params: &[F<VarFloat<N>>], left_threshold_params: Option<&ThresholdParams<VarFloat<N>>>, right_threshold_params: Option<&ThresholdParams<VarFloat<N>>>, lu_params: Option<&LUParams<VarFloat<N>>>, ) -> InputParams<'a, VarFloat<N>>

Auto Trait Implementations§

§

impl<const N: u32> Freeze for VarFloat<N>

§

impl<const N: u32> RefUnwindSafe for VarFloat<N>

§

impl<const N: u32> Send for VarFloat<N>

§

impl<const N: u32> Sync for VarFloat<N>

§

impl<const N: u32> Unpin for VarFloat<N>

§

impl<const N: u32> UnsafeUnpin for VarFloat<N>

§

impl<const N: u32> UnwindSafe for VarFloat<N>

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
§

impl<T> AtomComponentOptimizable<()> for T

Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

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

Source§

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

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

impl<T, Right> ClosedAdd<Right> for T
where T: Add<Right, Output = T> + AddAssign<Right>,

§

impl<T, Right> ClosedAdd<Right> for T
where T: Add<Right, Output = T> + AddAssign<Right>,

§

impl<T, Right> ClosedAddAssign<Right> for T
where T: ClosedAdd<Right> + AddAssign<Right>,

§

impl<T, Right> ClosedDiv<Right> for T
where T: Div<Right, Output = T> + DivAssign<Right>,

§

impl<T, Right> ClosedDiv<Right> for T
where T: Div<Right, Output = T> + DivAssign<Right>,

§

impl<T, Right> ClosedDivAssign<Right> for T
where T: ClosedDiv<Right> + DivAssign<Right>,

§

impl<T, Right> ClosedMul<Right> for T
where T: Mul<Right, Output = T> + MulAssign<Right>,

§

impl<T, Right> ClosedMul<Right> for T
where T: Mul<Right, Output = T> + MulAssign<Right>,

§

impl<T, Right> ClosedMulAssign<Right> for T
where T: ClosedMul<Right> + MulAssign<Right>,

§

impl<T> ClosedNeg for T
where T: Neg<Output = T>,

§

impl<T> ClosedNeg for T
where T: Neg<Output = T>,

§

impl<T, Right> ClosedSub<Right> for T
where T: Sub<Right, Output = T> + SubAssign<Right>,

§

impl<T, Right> ClosedSub<Right> for T
where T: Sub<Right, Output = T> + SubAssign<Right>,

§

impl<T, Right> ClosedSubAssign<Right> for T
where T: ClosedSub<Right> + SubAssign<Right>,

§

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

§

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, 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
Source§

impl<T> IsDefault for T
where T: Default + PartialEq,

§

impl<T> IsZero for T
where T: RefZero + PartialEq,

§

fn is_zero(&self) -> bool

§

fn is_non_zero(&self) -> bool

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more
§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more
§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
§

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, Rhs, O> RefAdd<Rhs> for T
where &'a T: for<'a> Add<Rhs, Output = O>, T: ?Sized,

§

type Output = O

The resulting type after applying add operation.
§

fn ref_add(&self, rhs: Rhs) -> O

Performs add operation.
Source§

impl<T> RefDefault for T
where T: FloatLike,

Source§

fn default(&self) -> T

§

impl<T, Rhs, O> RefDiv<Rhs> for T
where &'a T: for<'a> Div<Rhs, Output = O>, T: ?Sized,

§

type Output = O

The resulting type after applying div operation.
§

fn ref_div(&self, rhs: Rhs) -> O

Performs div operation.
§

impl<T, Rhs, O> RefMul<Rhs> for T
where &'a T: for<'a> Mul<Rhs, Output = O>, T: ?Sized,

§

type Output = O

The resulting type after applying mul operation.
§

fn ref_mul(&self, rhs: Rhs) -> O

Performs mul operation.
§

impl<T, O> RefNeg for T
where &'a T: for<'a> Neg<Output = O>, T: ?Sized,

§

type Output = O

The resulting type after applying neg operation.
§

fn ref_neg(&self) -> O

Performs neg operation.
§

impl<T, Rhs, O> RefRem<Rhs> for T
where &'a T: for<'a> Rem<Rhs, Output = O>, T: ?Sized,

§

type Output = O

The resulting type after applying rem operation.
§

fn ref_rem(&self, rhs: Rhs) -> O

Performs rem operation.
§

impl<T, Rhs, O> RefSub<Rhs> for T
where &'a T: for<'a> Sub<Rhs, Output = O>, T: ?Sized,

§

type Output = O

The resulting type after applying sub operation.
§

fn ref_sub(&self, rhs: Rhs) -> O

Performs sub operation.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<T> SectionExt for T
where T: Display + Send + Sync + 'static,

Source§

fn header<C>(self, header: C) -> IndentedSection<C, T>
where C: Display + Send + Sync + 'static,

Add a header to a Section and indent the body Read more
Source§

impl<T> StatusRenderable for T
where T: Serialize + Display,

Source§

fn status_pretty(&self) -> Cow<'_, str>

Human-friendly, possibly multi-line (e.g. a table).
Source§

fn status_json(&self) -> Value

Machine-readable payload (stable shape for analysis).
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
§

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.
§

impl<T> ToCompactString for T
where T: Display,

§

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more
§

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more
§

impl<T> ToLine for T
where T: Display,

§

fn to_line(&self) -> Line<'_>

Converts the value to a [Line].
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> ToSpan for T
where T: Display,

§

fn to_span(&self) -> Span<'_>

Converts the value to a [Span].
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToText for T
where T: Display,

§

fn to_text(&self) -> Text<'_>

Converts the value to a [Text].
§

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.
§

impl<T, U> TryFromUpgrade<T> for U
where T: TrySmallestUpgrade<U, LCM = U>, U: Clone,

§

fn try_from_upgrade(value: &T) -> Option<U>

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<T, U> TryIntoUpgrade<U> for T
where U: TryFromUpgrade<T>,

§

fn try_into_upgrade(&self) -> Option<U>

Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
§

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> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.