Enum ValueFormat 

pub enum ValueFormat {
    Raw,
    Pretty,
    Both,
}

Value format for API responses

Controls how FormattedValue<T> fields are serialized in responses. This allows API consumers to choose between raw numeric values, human-readable formatted strings, or both.

Variants

Raw

Return only raw numeric values (e.g., 123.45) - default Best for programmatic use, calculations, charts

Pretty

Return only formatted strings (e.g., "$123.45", "1.2B") Best for display purposes

Both

Return both raw and formatted values Returns the full {raw, fmt, longFmt} object

Implementations

impl ValueFormat

pub fn parse(s: &str) -> Option<Self>

Parse from string (case-insensitive), returns None on invalid input

pub fn as_str(&self) -> &'static str

Convert to string representation

pub fn transform(&self, value: Value) -> Value

Transform a JSON value based on this format

Recursively processes the JSON, detecting FormattedValue objects (objects with raw key and optionally fmt/longFmt) and transforming them according to the format setting.

Example

use finance_query::ValueFormat;
use serde_json::json;

let data = json!({"price": {"raw": 123.45, "fmt": "$123.45"}});

// Raw format extracts just the raw value (default)
let raw = ValueFormat::default().transform(data.clone());
assert_eq!(raw, json!({"price": 123.45}));

// Pretty extracts just the formatted string
let pretty = ValueFormat::Pretty.transform(data.clone());
assert_eq!(pretty, json!({"price": "$123.45"}));

// Both keeps the full object
let both = ValueFormat::Both.transform(data);
assert_eq!(both, json!({"price": {"raw": 123.45, "fmt": "$123.45"}}));

Trait Implementations

impl Clone for ValueFormat

fn clone(&self) -> ValueFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueFormat

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

Formats the value using the given formatter.

impl Default for ValueFormat

fn default() -> ValueFormat

Returns the “default value” for a type.

impl FromStr for ValueFormat

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ValueFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ValueFormat

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

impl Eq for ValueFormat

impl StructuralPartialEq for ValueFormat