Struct arrow::util::display::FormatOptions
source · pub struct FormatOptions<'a> { /* private fields */ }
Expand description
Options for formatting arrays
By default nulls are formatted as ""
and temporal types formatted
according to RFC3339
Implementations§
source§impl<'a> FormatOptions<'a>
impl<'a> FormatOptions<'a>
pub const fn new() -> FormatOptions<'a>
sourcepub const fn with_display_error(self, safe: bool) -> FormatOptions<'a>
pub const fn with_display_error(self, safe: bool) -> FormatOptions<'a>
If set to true
any formatting errors will be written to the output
instead of being converted into a std::fmt::Error
sourcepub const fn with_null(self, null: &'a str) -> FormatOptions<'a>
pub const fn with_null(self, null: &'a str) -> FormatOptions<'a>
Overrides the string used to represent a null
Defaults to ""
sourcepub const fn with_date_format(
self,
date_format: Option<&'a str>,
) -> FormatOptions<'a>
pub const fn with_date_format( self, date_format: Option<&'a str>, ) -> FormatOptions<'a>
Overrides the format used for DataType::Date32
columns
sourcepub const fn with_datetime_format(
self,
datetime_format: Option<&'a str>,
) -> FormatOptions<'a>
pub const fn with_datetime_format( self, datetime_format: Option<&'a str>, ) -> FormatOptions<'a>
Overrides the format used for DataType::Date64
columns
sourcepub const fn with_timestamp_format(
self,
timestamp_format: Option<&'a str>,
) -> FormatOptions<'a>
pub const fn with_timestamp_format( self, timestamp_format: Option<&'a str>, ) -> FormatOptions<'a>
Overrides the format used for DataType::Timestamp
columns without a timezone
sourcepub const fn with_timestamp_tz_format(
self,
timestamp_tz_format: Option<&'a str>,
) -> FormatOptions<'a>
pub const fn with_timestamp_tz_format( self, timestamp_tz_format: Option<&'a str>, ) -> FormatOptions<'a>
Overrides the format used for DataType::Timestamp
columns with a timezone
sourcepub const fn with_time_format(
self,
time_format: Option<&'a str>,
) -> FormatOptions<'a>
pub const fn with_time_format( self, time_format: Option<&'a str>, ) -> FormatOptions<'a>
Overrides the format used for DataType::Time32
and DataType::Time64
columns
sourcepub const fn with_duration_format(
self,
duration_format: DurationFormat,
) -> FormatOptions<'a>
pub const fn with_duration_format( self, duration_format: DurationFormat, ) -> FormatOptions<'a>
Overrides the format used for duration columns
Defaults to DurationFormat::ISO8601
Trait Implementations§
source§impl<'a> Clone for FormatOptions<'a>
impl<'a> Clone for FormatOptions<'a>
source§fn clone(&self) -> FormatOptions<'a>
fn clone(&self) -> FormatOptions<'a>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<'a> Debug for FormatOptions<'a>
impl<'a> Debug for FormatOptions<'a>
source§impl<'a> Default for FormatOptions<'a>
impl<'a> Default for FormatOptions<'a>
source§fn default() -> FormatOptions<'a>
fn default() -> FormatOptions<'a>
Returns the “default value” for a type. Read more
source§impl<'a> Hash for FormatOptions<'a>
impl<'a> Hash for FormatOptions<'a>
source§impl<'a> PartialEq for FormatOptions<'a>
impl<'a> PartialEq for FormatOptions<'a>
impl<'a> Eq for FormatOptions<'a>
impl<'a> StructuralPartialEq for FormatOptions<'a>
Auto Trait Implementations§
impl<'a> Freeze for FormatOptions<'a>
impl<'a> RefUnwindSafe for FormatOptions<'a>
impl<'a> Send for FormatOptions<'a>
impl<'a> Sync for FormatOptions<'a>
impl<'a> Unpin for FormatOptions<'a>
impl<'a> UnwindSafe for FormatOptions<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)