Trait ArrayValue

pub trait ArrayValue:
    Default
    + Clone
    + Debug
    + Display
    + GridFmt
    + ArrayCmp
    + Send
    + Sync
    + 'static {
    const NAME: &'static str;
    const SYMBOL: char;
    const TYPE_ID: u8;

    // Required methods
    fn get_scalar_fill(fill: &Fill<'_>) -> Result<Self, &'static str>;
    fn get_array_fill(fill: &Fill<'_>) -> Result<Array<Self>, &'static str>;
    fn array_hash<H: Hasher>(&self, hasher: &mut H);
    fn proxy() -> Self;

    // Provided methods
    fn format_delims() -> (&'static str, &'static str) { ... }
    fn empty_list_inner() -> &'static str { ... }
    fn format_sep() -> &'static str { ... }
    fn grid_fmt_delims(boxed: bool) -> (char, char) { ... }
    fn compress_list_grid() -> bool { ... }
    fn nested_value(&self) -> Option<&Value> { ... }
    fn has_wildcard(&self) -> bool { ... }
    fn summarize(elems: &[Self]) -> String { ... }
    fn summary_min_elems() -> usize { ... }
    fn alignment() -> ElemAlign { ... }
    fn max_col_width<'a>(
        rows: impl Iterator<Item = &'a [char]> + Clone,
    ) -> usize { ... }
}

A trait for types that can be used as array elements

Required Associated Constants

const NAME: &'static str

The type name

const SYMBOL: char

A glyph indicating the type

const TYPE_ID: u8

An ID for the type

Required Methods

fn get_scalar_fill(fill: &Fill<'_>) -> Result<Self, &'static str>

Get the scalar fill value from the environment

fn get_array_fill(fill: &Fill<'_>) -> Result<Array<Self>, &'static str>

Get the array fill value from the environment

fn array_hash<H: Hasher>(&self, hasher: &mut H)

Hash the value

fn proxy() -> Self

Get the proxy value

Provided Methods

fn format_delims() -> (&'static str, &'static str)

Delimiters for formatting

fn empty_list_inner() -> &'static str

Marker for empty lists in grid formatting

fn format_sep() -> &'static str

Separator for formatting

fn grid_fmt_delims(boxed: bool) -> (char, char)

Delimiters for grid formatting

fn compress_list_grid() -> bool

Whether to compress all items of a list when grid formatting

fn nested_value(&self) -> Option<&Value>

Get a nested value

fn has_wildcard(&self) -> bool

Check if this element has the wildcard value

fn summarize(elems: &[Self]) -> String

Summarize the elements of an array of this type

fn summary_min_elems() -> usize

The minimum number of elements that require a summary

fn alignment() -> ElemAlign

How to align elements when formatting

fn max_col_width<'a>(rows: impl Iterator<Item = &'a [char]> + Clone) -> usize

How to determine the maximum width of a formatted column

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl ArrayValue for char

const NAME: &'static str = "character"

const SYMBOL: char = '@'

const TYPE_ID: u8 = 1u8

fn get_scalar_fill(fill: &Fill<'_>) -> Result<Self, &'static str>

fn get_array_fill(fill: &Fill<'_>) -> Result<Array<Self>, &'static str>

fn format_delims() -> (&'static str, &'static str)

fn format_sep() -> &'static str

fn array_hash<H: Hasher>(&self, hasher: &mut H)

fn proxy() -> Self

fn grid_fmt_delims(boxed: bool) -> (char, char)

fn compress_list_grid() -> bool

fn has_wildcard(&self) -> bool

fn summarize(elems: &[Self]) -> String

impl ArrayValue for f64

const NAME: &'static str = "number"

const SYMBOL: char = 'ℝ'

const TYPE_ID: u8 = 0u8

fn get_scalar_fill(fill: &Fill<'_>) -> Result<Self, &'static str>

fn get_array_fill(fill: &Fill<'_>) -> Result<Array<Self>, &'static str>

fn array_hash<H: Hasher>(&self, hasher: &mut H)

fn proxy() -> Self

fn has_wildcard(&self) -> bool

fn summarize(elems: &[Self]) -> String

fn alignment() -> ElemAlign

fn max_col_width<'a>(rows: impl Iterator<Item = &'a [char]>) -> usize

impl ArrayValue for u8

const NAME: &'static str = "number"

const SYMBOL: char = 'ℝ'

const TYPE_ID: u8 = 0u8

fn get_scalar_fill(fill: &Fill<'_>) -> Result<Self, &'static str>

fn get_array_fill(fill: &Fill<'_>) -> Result<Array<Self>, &'static str>

fn array_hash<H: Hasher>(&self, hasher: &mut H)

fn proxy() -> Self

fn summarize(elems: &[Self]) -> String

fn alignment() -> ElemAlign

Implementors

impl ArrayValue for Boxed

const NAME: &'static str = "box"

const SYMBOL: char = '□'

const TYPE_ID: u8 = 2u8

impl ArrayValue for Complex

const NAME: &'static str = "complex"

const SYMBOL: char = 'ℂ'

const TYPE_ID: u8 = 3u8