Struct FormattingOptions Copy item path

impl FormattingOptions

pub const fn new() -> FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Construct a new FormatterBuilder with the supplied Write trait object for output that is equivalent to the {} formatting specifier:

no flags,
filled with spaces,
no alignment,
no width,
no precision, and
no DebugAsHex output mode.

pub fn sign(&mut self, sign: Option<Sign>) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Sets or removes the sign (the + or the - flag).

+: This is intended for numeric types and indicates that the sign should always be printed. By default only the negative sign of signed values is printed, and the sign of positive or unsigned values is omitted. This flag indicates that the correct sign (+ or -) should always be printed.
-: Currently not used

pub fn sign_aware_zero_pad( &mut self, sign_aware_zero_pad: bool, ) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Sets or unsets the 0 flag.

This is used to indicate for integer formats that the padding to width should both be done with a 0 character as well as be sign-aware

pub fn alternate(&mut self, alternate: bool) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Sets or unsets the # flag.

This flag indicates that the “alternate” form of printing should be used. The alternate forms are:

Debug : pretty-print the Debug formatting (adds linebreaks and indentation)
LowerHex as well as UpperHex - precedes the argument with a 0x
Octal - precedes the argument with a 0b
Binary - precedes the argument with a 0o

pub fn fill(&mut self, fill: char) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Sets the fill character.

The optional fill character and alignment is provided normally in conjunction with the width parameter. This indicates that if the value being formatted is smaller than width some extra characters will be printed around it.

pub fn align(&mut self, align: Option<Alignment>) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Sets or removes the alignment.

The alignment specifies how the value being formatted should be positioned if it is smaller than the width of the formatter.

pub fn width(&mut self, width: Option<usize>) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Sets or removes the width.

This is a parameter for the “minimum width” that the format should take up. If the value’s string does not fill up this many characters, then the padding specified by FormattingOptions::fill/FormattingOptions::align will be used to take up the required space.

pub fn precision(&mut self, precision: Option<usize>) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Sets or removes the precision.

For non-numeric types, this can be considered a “maximum width”. If the resulting string is longer than this width, then it is truncated down to this many characters and that truncated value is emitted with proper fill, alignment and width if those parameters are set.
For integral types, this is ignored.
For floating-point types, this indicates how many digits after the decimal point should be printed.

pub fn debug_as_hex( &mut self, debug_as_hex: Option<DebugAsHex>, ) -> &mut FormattingOptions

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Specifies whether the Debug trait should use lower-/upper-case hexadecimal or normal integers

pub const fn get_sign(&self) -> Option<Sign> ⓘ

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current sign (the + or the - flag).

pub const fn get_sign_aware_zero_pad(&self) -> bool

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current 0 flag.

pub const fn get_alternate(&self) -> bool

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current # flag.

pub const fn get_fill(&self) -> char

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current fill character.

pub const fn get_align(&self) -> Option<Alignment> ⓘ

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current alignment.

pub const fn get_width(&self) -> Option<usize> ⓘ

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current width.

pub const fn get_precision(&self) -> Option<usize> ⓘ

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current precision.

pub const fn get_debug_as_hex(&self) -> Option<DebugAsHex> ⓘ

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Returns the current precision.

pub fn create_formatter<'a>(self, write: &'a mut dyn Write) -> Formatter<'a>

🔬This is a nightly-only experimental API. (formatting_options)

Available on crate feature alloc only.

Creates a Formatter that writes its output to the given Write trait.

You may alternatively use Formatter::new().

Trait Implementations§

impl Clone for FormattingOptions

fn clone(&self) -> FormattingOptions

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 Debug for FormattingOptions

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

Formats the value using the given formatter. Read more

fn eq(&self, other: &FormattingOptions) -> 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 Copy for FormattingOptions

impl Eq for FormattingOptions

impl StructuralPartialEq for FormattingOptions

Auto Trait Implementations§

impl Freeze for FormattingOptions

impl RefUnwindSafe for FormattingOptions

impl Send for FormattingOptions

impl Sync for FormattingOptions

impl Unpin for FormattingOptions

impl UnwindSafe for FormattingOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.

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

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

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

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<T> ExtAny for T
where T: Any + ?Sized,

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

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

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Hook for T

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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