Struct arrow_cast::display::FormatOptions

pub struct FormatOptions<'a> { /* private fields */ }

Options for formatting arrays

By default nulls are formatted as "" and temporal types formatted according to RFC3339

Implementations

impl<'a> FormatOptions<'a>

pub const fn new() -> Self

pub const fn with_display_error(self, safe: bool) -> Self

If set to true any formatting errors will be written to the output instead of being converted into a std::fmt::Error

pub const fn with_null(self, null: &'a str) -> Self

Overrides the string used to represent a null

Defaults to ""

pub const fn with_date_format(self, date_format: Option<&'a str>) -> Self

Overrides the format used for DataType::Date32 columns

pub const fn with_datetime_format( self, datetime_format: Option<&'a str>, ) -> Self

Overrides the format used for DataType::Date64 columns

pub const fn with_timestamp_format( self, timestamp_format: Option<&'a str>, ) -> Self

Overrides the format used for DataType::Timestamp columns without a timezone

pub const fn with_timestamp_tz_format( self, timestamp_tz_format: Option<&'a str>, ) -> Self

Overrides the format used for DataType::Timestamp columns with a timezone

pub const fn with_time_format(self, time_format: Option<&'a str>) -> Self

Overrides the format used for DataType::Time32 and DataType::Time64 columns

pub const fn with_duration_format(self, duration_format: DurationFormat) -> Self

Overrides the format used for duration columns

Defaults to DurationFormat::ISO8601

Trait Implementations

impl<'a> Clone for FormatOptions<'a>

fn clone(&self) -> FormatOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FormatOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for FormatOptions<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Hash for FormatOptions<'a>

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<'a> PartialEq for FormatOptions<'a>

fn eq(&self, other: &FormatOptions<'a>) -> 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<'a> Eq for FormatOptions<'a>

impl<'a> StructuralPartialEq for FormatOptions<'a>