Struct NumberFormat 

pub struct NumberFormat { /* private fields */ }

A parsed number format code. Cheap to clone.

Implementations

impl NumberFormat

pub fn parse(code: &str) -> NumberFormat

Parses a format code. Never fails: unknown or malformed parts degrade to literal text, and a code longer than MAX_FORMAT_CODE_CHARS characters degrades to General.

pub fn general() -> NumberFormat

pub fn code(&self) -> &str

pub fn is_general(&self) -> bool

pub fn is_date(&self) -> bool

True when the code contains date or time tokens.

pub fn date_shape(&self, value: f64) -> Option<(bool, bool)>

For a date or time format, whether the section that formats value shows calendar parts (year, month, day) and whether it shows time parts, as (date, time). None for any other format and for elapsed-time codes like [h]:mm, whose value is a duration, not a moment.

pub fn is_percent(&self) -> bool

pub fn is_text(&self) -> bool

True for a pure text format such as @.

pub fn kind(&self) -> FormatKind

Best guess at the format category for the ribbon’s dropdown.

pub fn round_as_displayed(&self, n: f64) -> f64

The number n as this format displays it: what Excel stores when “Set precision as displayed” is on. Fixed decimals, percent, thousands scaling (0.0,,), scientific and fraction sections round to what they show; the section is picked as for display, so 0.00;(0.0) keeps one decimal for negatives. Observed in Excel (COM, Workbook.PrecisionAsDisplayed), these keep the full value: General, date and time formats (mm:ss.0 included), text formats and sections without digits ("x", ;;;). The section is picked by NumberFormat::rounding_section, which ignores conditions. Never returns -0.

impl NumberFormat

pub fn parse_cached(code: &str) -> NumberFormat

Like NumberFormat::parse, but remembers recently parsed codes (per thread, bounded) so formatting many values with one code parses it once. Same result as parse.

Trait Implementations

impl Clone for NumberFormat

fn clone(&self) -> NumberFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumberFormat

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

Formats the value using the given formatter.

impl Default for NumberFormat

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for NumberFormat

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.