arrow::util::display

Struct FormatOptions

pub struct FormatOptions<'a> {
    safe: bool,
    null: &'a str,
    date_format: Option<&'a str>,
    datetime_format: Option<&'a str>,
    timestamp_format: Option<&'a str>,
    timestamp_tz_format: Option<&'a str>,
    time_format: Option<&'a str>,
    duration_format: DurationFormat,
}
Expand description

Options for formatting arrays

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

Fields§

§safe: bool§null: &'a str§date_format: Option<&'a str>§datetime_format: Option<&'a str>§timestamp_format: Option<&'a str>§timestamp_tz_format: Option<&'a str>§time_format: Option<&'a str>§duration_format: DurationFormat

Implementations§

§

impl<'a> FormatOptions<'a>

pub const fn new() -> FormatOptions<'a>

Creates a new set of format options

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

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

Overrides the string used to represent a null

Defaults to ""

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

Overrides the format used for DataType::Date32 columns

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

Overrides the format used for DataType::Date64 columns

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

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

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

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§

§

impl<'a> Clone for 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)

Performs copy-assignment from source. Read more
§

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

§

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

Formats the value using the given formatter. Read more
§

impl Default for FormatOptions<'_>

§

fn default() -> FormatOptions<'_>

Returns the “default value” for a type. Read more
§

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

§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

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 ==.
1.0.0 · Source§

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>

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> 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, dst: *mut u8)

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

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

§

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

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

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

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

impl<T> Ungil for T
where T: Send,