Skip to main content

OutputSurface

Enum OutputSurface 

Source
pub enum OutputSurface {
    Human,
    Machine,
    LedgerText,
}
Expand description

What kind of consumer an output surface is written for.

Decides whether thousands separators appear. The question is not “will a person read this” but does the consumer have a grammar:

  • machine interchange (CSV, JSON) does not. A separator forces the field to be quoted and is then rejected by ordinary decimal parsers — Decimal(field) breaks (issue #1892). Suppressed unconditionally, and that suppression outranks any ledger or per-commodity declaration.
  • ledger text (format, query --format beancount) does. Grouped numerals are part of Beancount syntax, so every conforming reader must accept them; the parser, not the file, is the machine boundary. Honors the ledger’s declaration (#1896).
  • rendered tables read by a person likewise honor it.

This exists so the rule is stated ONCE. It was previously re-derived per writer, and the surfaces had already drifted apart: query --format beancount emitted separators into ledger text while format stripped them, and CSV emitted them while JSON did not.

LedgerText initially suppressed them, on the premise that ledger text has one canonical on-disk form. #1896 abandoned that premise deliberately — rledger format --ledger now GROUPS, because a ledger that asks for separators should get them in the file it owns — which put the two ledger text producers back in disagreement until this arm followed. Beancount itself groups here: grammar.py calls dcontext.set_commas(options ["render_commas"]) while parsing, and printer.py renders through that same context.

Variants§

§

Human

A rendered table or report read by a person.

§

Machine

CSV/JSON consumed by another program.

§

LedgerText

Beancount source text.

Implementations§

Source§

impl OutputSurface

Source

pub const fn renders_thousands_separators(self) -> bool

Whether this surface renders thousands separators when the ledger asks for them.

Only Self::Machine refuses, because only its consumers lack a grammar that admits the separator.

Trait Implementations§

Source§

impl Clone for OutputSurface

Source§

fn clone(&self) -> OutputSurface

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OutputSurface

Source§

impl Debug for OutputSurface

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for OutputSurface

Source§

impl PartialEq for OutputSurface

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OutputSurface

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.