Struct DisplayFormatOptions

#[non_exhaustive]
pub struct DisplayFormatOptions {
    pub use_blank_cell_format: bool,
    pub blank_cell_format: Option<String>,
    pub date_format: Option<String>,
    pub decimal_separator: Option<TopicNumericSeparatorSymbol>,
    pub grouping_separator: Option<String>,
    pub use_grouping: bool,
    pub fraction_digits: i32,
    pub prefix: Option<String>,
    pub suffix: Option<String>,
    pub unit_scaler: Option<NumberScale>,
    pub negative_format: Option<NegativeFormat>,
    pub currency_symbol: Option<String>,
}

A structure that represents additional options for display formatting.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

use_blank_cell_format: bool

A Boolean value that indicates whether to use blank cell format.

blank_cell_format: Option<String>

Determines the blank cell format.

date_format: Option<String>

Determines the DateTime format.

decimal_separator: Option<TopicNumericSeparatorSymbol>

Determines the decimal separator.

grouping_separator: Option<String>

Determines the grouping separator.

use_grouping: bool

A Boolean value that indicates whether to use grouping.

fraction_digits: i32

Determines the number of fraction digits.

prefix: Option<String>

The prefix value for a display format.

suffix: Option<String>

The suffix value for a display format.

unit_scaler: Option<NumberScale>

The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

negative_format: Option<NegativeFormat>

The negative format.

currency_symbol: Option<String>

The currency symbol, such as USD.

Implementations

impl DisplayFormatOptions

pub fn use_blank_cell_format(&self) -> bool

A Boolean value that indicates whether to use blank cell format.

pub fn blank_cell_format(&self) -> Option<&str>

Determines the blank cell format.

pub fn date_format(&self) -> Option<&str>

Determines the DateTime format.

pub fn decimal_separator(&self) -> Option<&TopicNumericSeparatorSymbol>

Determines the decimal separator.

pub fn grouping_separator(&self) -> Option<&str>

Determines the grouping separator.

pub fn use_grouping(&self) -> bool

A Boolean value that indicates whether to use grouping.

pub fn fraction_digits(&self) -> i32

Determines the number of fraction digits.

pub fn prefix(&self) -> Option<&str>

The prefix value for a display format.

pub fn suffix(&self) -> Option<&str>

The suffix value for a display format.

pub fn unit_scaler(&self) -> Option<&NumberScale>

The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

pub fn negative_format(&self) -> Option<&NegativeFormat>

The negative format.

pub fn currency_symbol(&self) -> Option<&str>

The currency symbol, such as USD.

impl DisplayFormatOptions

pub fn builder() -> DisplayFormatOptionsBuilder

Creates a new builder-style object to manufacture DisplayFormatOptions.

Trait Implementations

impl Clone for DisplayFormatOptions

fn clone(&self) -> DisplayFormatOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayFormatOptions

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

Formats the value using the given formatter.

impl PartialEq for DisplayFormatOptions

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

Tests for self and other values to be equal, and is used by ==.

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 StructuralPartialEq for DisplayFormatOptions