Struct PWrapper
pub struct PWrapper<T>(pub T);
Expand description
Wrapper for many std types,
which implements the const_debug_fmt
and/or const_display_fmt
methods for them.
The macros from this crate automatically wraps std types in this type,
so you only need to use it if you’re manually calling the const_*_fmt
methods.
§Constructors
Most std types can be wrapped in this type simply by doing PWrapper(value)
.
To wrap arrays, there is the PWrapper::slice
constructor
for convenience.
§Excluded std types
Note that this type does not implement the formatting methods for std types which wrap non-std types, only for a selection of wrapped std types.
You can use the call_debug_fmt
macro to format arrays/slices/Options of
any type that can be const debug formatted.
§Example
This example demonstrates how you can implement debug formatting for a type using PWrapper to write std types.
use const_format::{Error, Formatter, PWrapper};
use const_format::{impl_fmt, formatc, try_};
use core::num::NonZeroU32;
pub struct Divide(pub u32, pub u32);
impl_fmt!{
impl Divide;
pub const fn const_debug_fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
let Self(left, right) = *self;
let divided = self.0 / self.1;
let mut f = f.debug_struct("Divide");
try_!(PWrapper(self.0).const_debug_fmt(f.field("numerator")));
try_!(PWrapper(self.1).const_debug_fmt(f.field("denominator")));
try_!(PWrapper(divided).const_debug_fmt(f.field("divided")));
f.finish()
}
}
const TEXT: &str = formatc!("{:?}", Divide(34, 11));
const T_HEX: &str = formatc!("{:X?}", Divide(34, 11));
const T_BIN: &str = formatc!("{:b?}", Divide(34, 11));
assert_eq!(TEXT, "Divide { numerator: 34, denominator: 11, divided: 3 }");
assert_eq!(T_HEX, "Divide { numerator: 22, denominator: B, divided: 3 }");
assert_eq!(T_BIN, "Divide { numerator: 100010, denominator: 1011, divided: 11 }");
Tuple Fields§
§0: T
Implementations§
§impl PWrapper<i8>
impl PWrapper<i8>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<i8>
impl PWrapper<i8>
pub const fn unsigned_abs(self) -> u8
pub const fn unsigned_abs(self) -> u8
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<i16>
impl PWrapper<i16>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<i16>
impl PWrapper<i16>
pub const fn unsigned_abs(self) -> u16
pub const fn unsigned_abs(self) -> u16
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<i32>
impl PWrapper<i32>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<i32>
impl PWrapper<i32>
pub const fn unsigned_abs(self) -> u32
pub const fn unsigned_abs(self) -> u32
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<i64>
impl PWrapper<i64>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<i64>
impl PWrapper<i64>
pub const fn unsigned_abs(self) -> u64
pub const fn unsigned_abs(self) -> u64
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<i128>
impl PWrapper<i128>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<i128>
impl PWrapper<i128>
pub const fn unsigned_abs(self) -> u128
pub const fn unsigned_abs(self) -> u128
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<u8>
impl PWrapper<u8>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<u8>
impl PWrapper<u8>
pub const fn unsigned_abs(self) -> u8
pub const fn unsigned_abs(self) -> u8
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<u16>
impl PWrapper<u16>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<u16>
impl PWrapper<u16>
pub const fn unsigned_abs(self) -> u16
pub const fn unsigned_abs(self) -> u16
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<u32>
impl PWrapper<u32>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<u32>
impl PWrapper<u32>
pub const fn unsigned_abs(self) -> u32
pub const fn unsigned_abs(self) -> u32
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<u64>
impl PWrapper<u64>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<u64>
impl PWrapper<u64>
pub const fn unsigned_abs(self) -> u64
pub const fn unsigned_abs(self) -> u64
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<u128>
impl PWrapper<u128>
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<u128>
impl PWrapper<u128>
pub const fn unsigned_abs(self) -> u128
pub const fn unsigned_abs(self) -> u128
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<usize>
impl PWrapper<usize>
pub const fn compute_display_len(self, fmt: FormattingFlags) -> usize
pub const fn compute_display_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a literal.
pub const fn compute_debug_len(self, fmt: FormattingFlags) -> usize
pub const fn compute_debug_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a literal.
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<isize>
impl PWrapper<isize>
pub const fn compute_display_len(self, fmt: FormattingFlags) -> usize
pub const fn compute_display_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a literal.
pub const fn compute_debug_len(self, fmt: FormattingFlags) -> usize
pub const fn compute_debug_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a literal.
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
pub const fn hexadecimal_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a hexadecimal literal.
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
pub const fn binary_len(self, fmt: FormattingFlags) -> usize
Computes how long much space is necessary to write this integer as a binary literal.
§impl PWrapper<usize>
impl PWrapper<usize>
pub const fn unsigned_abs(self) -> usize
pub const fn unsigned_abs(self) -> usize
Returns the absolute value of this integer.
§impl PWrapper<isize>
impl PWrapper<isize>
pub const fn unsigned_abs(self) -> usize
pub const fn unsigned_abs(self) -> usize
Returns the absolute value of this integer, as the equivalent unsigned type.
§impl PWrapper<&[u8]>
impl PWrapper<&[u8]>
pub const fn compute_utf8_debug_len(self) -> usize
pub const fn compute_utf8_debug_len(self) -> usize
Computes how much space is necessary to write the wrapped &[u8]
as a utf8 string,
with debug formatting
pub const fn compute_utf8_debug_len_in_range(self, range: Range<usize>) -> usize
pub const fn compute_utf8_debug_len_in_range(self, range: Range<usize>) -> usize
Computes how much space is necessary to write &self.0[range]
as a utf8 string,
with debug formatting
Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for PWrapper<T>where
T: Freeze,
impl<T> RefUnwindSafe for PWrapper<T>where
T: RefUnwindSafe,
impl<T> Send for PWrapper<T>where
T: Send,
impl<T> Sync for PWrapper<T>where
T: Sync,
impl<T> Unpin for PWrapper<T>where
T: Unpin,
impl<T> UnwindSafe for PWrapper<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
Source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
Source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
Source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
Source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
Source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
Source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.Source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
Source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
§impl<F, W, T, D> Deserialize<With<T, W>, D> for F
impl<F, W, T, D> Deserialize<With<T, W>, D> for F
§fn deserialize(
&self,
deserializer: &mut D,
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSend for T
impl<T> DowncastSend for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
Source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.Source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
Source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
Source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.Source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
Source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.Source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.Source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
Source§fn into_color(self) -> U
fn into_color(self) -> U
Source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
Source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
Source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Pointee for T
impl<T> Pointee for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> SerializableKey for T
impl<T> SerializableKey for T
§impl<T> StorageAccess<T> for T
impl<T> StorageAccess<T> for T
§fn as_borrowed(&self) -> &T
fn as_borrowed(&self) -> &T
§fn into_taken(self) -> T
fn into_taken(self) -> T
Source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
Source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.Source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
Source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
Source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more