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§
Source§impl PWrapper<NonZeroU16>
impl PWrapper<NonZeroU16>
Sourcepub const fn const_eq(&self, r: &NonZeroU16) -> bool
pub const fn const_eq(&self, r: &NonZeroU16) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroI16>
impl PWrapper<NonZeroI16>
Sourcepub const fn const_eq(&self, r: &NonZeroI16) -> bool
pub const fn const_eq(&self, r: &NonZeroI16) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroU32>
impl PWrapper<NonZeroU32>
Sourcepub const fn const_eq(&self, r: &NonZeroU32) -> bool
pub const fn const_eq(&self, r: &NonZeroU32) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroI32>
impl PWrapper<NonZeroI32>
Sourcepub const fn const_eq(&self, r: &NonZeroI32) -> bool
pub const fn const_eq(&self, r: &NonZeroI32) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroU64>
impl PWrapper<NonZeroU64>
Sourcepub const fn const_eq(&self, r: &NonZeroU64) -> bool
pub const fn const_eq(&self, r: &NonZeroU64) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroI64>
impl PWrapper<NonZeroI64>
Sourcepub const fn const_eq(&self, r: &NonZeroI64) -> bool
pub const fn const_eq(&self, r: &NonZeroI64) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroU128>
impl PWrapper<NonZeroU128>
Sourcepub const fn const_eq(&self, r: &NonZeroU128) -> bool
pub const fn const_eq(&self, r: &NonZeroU128) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroI128>
impl PWrapper<NonZeroI128>
Sourcepub const fn const_eq(&self, r: &NonZeroI128) -> bool
pub const fn const_eq(&self, r: &NonZeroI128) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroUsize>
impl PWrapper<NonZeroUsize>
Sourcepub const fn const_eq(&self, r: &NonZeroUsize) -> bool
pub const fn const_eq(&self, r: &NonZeroUsize) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<NonZeroIsize>
impl PWrapper<NonZeroIsize>
Sourcepub const fn const_eq(&self, r: &NonZeroIsize) -> bool
pub const fn const_eq(&self, r: &NonZeroIsize) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroU16>>
impl PWrapper<Option<NonZeroU16>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroU16>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroU16>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroI16>>
impl PWrapper<Option<NonZeroI16>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroI16>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroI16>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroU32>>
impl PWrapper<Option<NonZeroU32>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroU32>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroU32>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroI32>>
impl PWrapper<Option<NonZeroI32>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroI32>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroI32>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroU64>>
impl PWrapper<Option<NonZeroU64>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroU64>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroU64>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroI64>>
impl PWrapper<Option<NonZeroI64>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroI64>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroI64>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroU128>>
impl PWrapper<Option<NonZeroU128>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroU128>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroU128>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroI128>>
impl PWrapper<Option<NonZeroI128>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroI128>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroI128>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroUsize>>
impl PWrapper<Option<NonZeroUsize>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroUsize>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroUsize>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Option<NonZeroIsize>>
impl PWrapper<Option<NonZeroIsize>>
Sourcepub const fn const_eq(&self, other: &Option<NonZeroIsize>) -> bool
pub const fn const_eq(&self, other: &Option<NonZeroIsize>) -> bool
This method is only available with the “assert” feature.
Source§impl<T: ?Sized> PWrapper<PhantomData<T>>
impl<T: ?Sized> PWrapper<PhantomData<T>>
Sourcepub const fn const_eq(&self, r: &PhantomData<T>) -> bool
pub const fn const_eq(&self, r: &PhantomData<T>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<PhantomPinned>
impl PWrapper<PhantomPinned>
Sourcepub const fn const_eq(&self, r: &PhantomPinned) -> bool
pub const fn const_eq(&self, r: &PhantomPinned) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<Ordering>
impl PWrapper<Ordering>
Sourcepub const fn const_eq(&self, r: &AtomicOrdering) -> bool
pub const fn const_eq(&self, r: &AtomicOrdering) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<RangeInclusive<usize>>
impl PWrapper<RangeInclusive<usize>>
Sourcepub const fn const_eq(&self, r: &RangeInclusive<usize>) -> bool
pub const fn const_eq(&self, r: &RangeInclusive<usize>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<RangeToInclusive<usize>>
impl PWrapper<RangeToInclusive<usize>>
Sourcepub const fn const_eq(&self, r: &RangeToInclusive<usize>) -> bool
pub const fn const_eq(&self, r: &RangeToInclusive<usize>) -> bool
This method is only available with the “assert” feature.
Source§impl PWrapper<RangeToInclusive<usize>>
impl PWrapper<RangeToInclusive<usize>>
Source§impl PWrapper<RangeInclusive<usize>>
impl PWrapper<RangeInclusive<usize>>
Source§impl PWrapper<Option<NonZeroU16>>
impl PWrapper<Option<NonZeroU16>>
Source§impl PWrapper<Option<NonZeroI16>>
impl PWrapper<Option<NonZeroI16>>
Source§impl PWrapper<Option<NonZeroU32>>
impl PWrapper<Option<NonZeroU32>>
Source§impl PWrapper<Option<NonZeroI32>>
impl PWrapper<Option<NonZeroI32>>
Source§impl PWrapper<Option<NonZeroU64>>
impl PWrapper<Option<NonZeroU64>>
Source§impl PWrapper<Option<NonZeroI64>>
impl PWrapper<Option<NonZeroI64>>
Source§impl PWrapper<Option<NonZeroU128>>
impl PWrapper<Option<NonZeroU128>>
Source§impl PWrapper<Option<NonZeroI128>>
impl PWrapper<Option<NonZeroI128>>
Source§impl PWrapper<Option<NonZeroUsize>>
impl PWrapper<Option<NonZeroUsize>>
Source§impl PWrapper<Option<NonZeroIsize>>
impl PWrapper<Option<NonZeroIsize>>
Source§impl PWrapper<NonZeroU16>
impl PWrapper<NonZeroU16>
Source§impl PWrapper<NonZeroI16>
impl PWrapper<NonZeroI16>
Source§impl PWrapper<NonZeroU32>
impl PWrapper<NonZeroU32>
Source§impl PWrapper<NonZeroI32>
impl PWrapper<NonZeroI32>
Source§impl PWrapper<NonZeroU64>
impl PWrapper<NonZeroU64>
Source§impl PWrapper<NonZeroI64>
impl PWrapper<NonZeroI64>
Source§impl PWrapper<NonZeroU128>
impl PWrapper<NonZeroU128>
Source§impl PWrapper<NonZeroI128>
impl PWrapper<NonZeroI128>
Source§impl PWrapper<NonZeroUsize>
impl PWrapper<NonZeroUsize>
Source§impl PWrapper<NonZeroIsize>
impl PWrapper<NonZeroIsize>
Source§impl<T: ?Sized> PWrapper<PhantomData<T>>
impl<T: ?Sized> PWrapper<PhantomData<T>>
Source§impl PWrapper<PhantomPinned>
impl PWrapper<PhantomPinned>
Source§impl PWrapper<i8>
impl PWrapper<i8>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<i8>
impl PWrapper<i8>
Sourcepub 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.
Source§impl PWrapper<i16>
impl PWrapper<i16>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<i16>
impl PWrapper<i16>
Sourcepub 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.
Source§impl PWrapper<i32>
impl PWrapper<i32>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<i32>
impl PWrapper<i32>
Sourcepub 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.
Source§impl PWrapper<i64>
impl PWrapper<i64>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<i64>
impl PWrapper<i64>
Sourcepub 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.
Source§impl PWrapper<i128>
impl PWrapper<i128>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<i128>
impl PWrapper<i128>
Sourcepub 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.
Source§impl PWrapper<u8>
impl PWrapper<u8>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<u8>
impl PWrapper<u8>
Sourcepub 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.
Source§impl PWrapper<u16>
impl PWrapper<u16>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<u16>
impl PWrapper<u16>
Sourcepub 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.
Source§impl PWrapper<u32>
impl PWrapper<u32>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<u32>
impl PWrapper<u32>
Sourcepub 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.
Source§impl PWrapper<u64>
impl PWrapper<u64>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<u64>
impl PWrapper<u64>
Sourcepub 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.
Source§impl PWrapper<u128>
impl PWrapper<u128>
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<u128>
impl PWrapper<u128>
Sourcepub 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.
Source§impl PWrapper<usize>
impl PWrapper<usize>
Sourcepub 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.
Sourcepub 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.
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<isize>
impl PWrapper<isize>
Sourcepub 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.
Sourcepub 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.
Sourcepub 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.
Sourcepub 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.
Source§impl PWrapper<usize>
impl PWrapper<usize>
Sourcepub const fn unsigned_abs(self) -> usize
pub const fn unsigned_abs(self) -> usize
Returns the absolute value of this integer.
Source§impl PWrapper<isize>
impl PWrapper<isize>
Sourcepub 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.
Source§impl PWrapper<&[u8]>
impl PWrapper<&[u8]>
Sourcepub 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
Sourcepub 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§
Source§impl<P> FormatMarker for PWrapper<P>
impl<P> FormatMarker for PWrapper<P>
impl<T: Copy> Copy for PWrapper<T>
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<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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.