Skip to main content

FieldFormat

Enum FieldFormat 

Source
#[non_exhaustive]
pub enum FieldFormat { Text, Number { unit: Option<&'static str>, }, Percentage, Boolean, Timestamp, Position, Enum { variants: &'static [&'static str], }, Nested { nested_type_id: TypeId, }, List { item_format: Box<FieldFormat>, }, JsonString, BlobRef, }
Expand description

How a single field is intended to be rendered. Downstream renderers (CLI typed-output paths, operator UIs, introspection tools) dispatch off this to pick a display strategy. The renderer owns the actual formatting; the descriptor just carries the hint.

FieldFormat::Text is the safe default — a renderer that doesn’t recognise a more specific variant can always fall back to text.

#[non_exhaustive]: additional format hints can be added in follow-on commits without breaking external consumers that match on this enum (they need a wildcard arm).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Text

Plain string. Renderer displays the value verbatim.

§

Number

Numeric value with an optional unit suffix (e.g. "m", "m/s", "min"). Renderer typically displays "<n> <unit>".

Fields

§unit: Option<&'static str>
§

Percentage

Floating-point value in [0.0, 1.0] rendered as a percentage (e.g. 0.95"95.0%").

§

Boolean

Boolean — true/false.

§

Timestamp

common.v1.Timestamp — renderer typically emits RFC 3339.

§

Position

common.v1.Position — renderer typically emits "<lat>°N, <lon>°W, <alt>m".

§

Enum

Enum (proto3 integer at the wire level). Variants are the canonical proto3 names in declaration order; index by integer value to look up the label. Renderer typically displays the label.

Fields

§variants: &'static [&'static str]
§

Nested

Nested protobuf message. Renderer recurses via the registry to the referenced type’s TypeDescriptor. nested_type_id is the canonical id of the sub-message.

Fields

§nested_type_id: TypeId
§

List

Repeated field. item_format describes how each element renders. Renderer typically emits a list / table.

Fields

§item_format: Box<FieldFormat>
§

JsonString

JSON-encoded string field (e.g. proto3 metadata_json). Renderer typically pretty-prints the embedded JSON.

§

BlobRef

BlobRef metadata — renderer emits "<blob:<size> sha256:<hash>>" without dereferencing the blob contents.

Trait Implementations§

Source§

impl Clone for FieldFormat

Source§

fn clone(&self) -> FieldFormat

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

Source§

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

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

impl Eq for FieldFormat

Source§

impl PartialEq for FieldFormat

Source§

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

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> 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<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> 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.