FormatOptions

datafusion_python::datafusion_common::config

Struct FormatOptions

pub struct FormatOptions {
    pub safe: bool,
    pub null: String,
    pub date_format: Option<String>,
    pub datetime_format: Option<String>,
    pub timestamp_format: Option<String>,
    pub timestamp_tz_format: Option<String>,
    pub time_format: Option<String>,
    pub duration_format: String,
    pub types_info: bool,
}

Expand description

Options controlling the format of output when printing record batches Copies arrow::util::display::FormatOptions

Fields§

§safe: bool

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

§null: String

Format string for nulls

§date_format: Option<String>

Date format for date arrays

§datetime_format: Option<String>

Format for DateTime arrays

§timestamp_format: Option<String>

Timestamp format for timestamp arrays

§timestamp_tz_format: Option<String>

Timestamp format for timestamp with timezone arrays. When None, ISO 8601 format is used.

§time_format: Option<String>

Time format for time arrays

§duration_format: String

Duration format. Can be either "pretty" or "ISO8601"

§types_info: bool

Show types in visual representation batches

Trait Implementations§

impl Clone for FormatOptions

fn clone(&self) -> FormatOptions

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl ConfigField for FormatOptions

fn set(&mut self, key: &str, value: &str) -> Result<(), DataFusionError>

fn visit<V>(&self, v: &mut V, key_prefix: &str, _description: &'static str)
where V: Visit,

impl Debug for FormatOptions

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

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

type Error = DataFusionError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<FormatOptions<'a>, DataFusionError>

Performs the conversion.

impl StructuralPartialEq for FormatOptions

Auto Trait Implementations§

impl Freeze for FormatOptions

impl RefUnwindSafe for FormatOptions

impl Send for FormatOptions

impl Sync for FormatOptions

impl Unpin for FormatOptions

impl UnwindSafe for FormatOptions

Blanket Implementations§

impl<T> AlignerFor<1> for T

type Aligner = AlignTo1<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<1024> for T

type Aligner = AlignTo1024<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<128> for T

type Aligner = AlignTo128<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<16> for T

type Aligner = AlignTo16<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<16384> for T

type Aligner = AlignTo16384<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<2> for T

type Aligner = AlignTo2<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<2048> for T

type Aligner = AlignTo2048<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<256> for T

type Aligner = AlignTo256<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<32> for T

type Aligner = AlignTo32<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<32768> for T

type Aligner = AlignTo32768<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<4> for T

type Aligner = AlignTo4<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<4096> for T

type Aligner = AlignTo4096<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<512> for T

type Aligner = AlignTo512<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<64> for T

type Aligner = AlignTo64<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<8> for T

type Aligner = AlignTo8<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<8192> for T

type Aligner = AlignTo8192<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

A constant of the type witness

impl<T> Identity for T
where T: ?Sized,

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<'a, T> RCowCompatibleRef<'a> for T
where T: Clone + 'a,

type RefC = &'a T

The (preferably) ffi-safe equivalent of &Self.

type ROwned = T

The owned version of Self::RefC.

fn as_c_ref(from: &'a T) -> <T as RCowCompatibleRef<'a>>::RefC

Converts a reference to an FFI-safe type

fn as_rust_ref(from: <T as RCowCompatibleRef<'a>>::RefC) -> &'a T

Converts an FFI-safe type to a reference

impl<S> ROExtAcc for S

fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F

Gets a reference to a field, determined by offset. Read more

fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F

Gets a muatble reference to a field, determined by offset. Read more

fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F

Gets a const pointer to a field, the field is determined by offset. Read more

fn f_get_mut_ptr<F, A>(&mut self, offset: FieldOffset<S, F, A>) -> *mut F

Gets a mutable pointer to a field, determined by offset. Read more

impl<S> ROExtOps<Aligned> for S

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Aligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Aligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> F
where F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

impl<S> ROExtOps<Unaligned> for S

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> F
where F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SelfOps for T
where T: ?Sized,

fn eq_id(&self, other: &Self) -> bool

Compares the address of self with the address of other. Read more

fn piped<F, U>(self, f: F) -> U
where F: FnOnce(Self) -> U, Self: Sized,

Emulates the pipeline operator, allowing method syntax in more places. Read more

fn piped_ref<'a, F, U>(&'a self, f: F) -> U
where F: FnOnce(&'a Self) -> U,

The same as piped except that the function takes &Self Useful for functions that take &Self instead of Self. Read more

fn piped_mut<'a, F, U>(&'a mut self, f: F) -> U
where F: FnOnce(&'a mut Self) -> U,

The same as piped, except that the function takes &mut Self. Useful for functions that take &mut Self instead of Self.

fn mutated<F>(self, f: F) -> Self
where F: FnOnce(&mut Self), Self: Sized,

Mutates self using a closure taking self by mutable reference, passing it along the method chain. Read more

fn observe<F>(self, f: F) -> Self
where F: FnOnce(&Self), Self: Sized,

Observes the value of self, passing it along unmodified. Useful in long method chains. Read more

fn into_<T>(self) -> T
where Self: Into<T>,

Performs a conversion with Into. using the turbofish .into_::<_>() syntax. Read more

fn as_ref_<T>(&self) -> &T
where Self: AsRef<T>, T: ?Sized,

Performs a reference to reference conversion with AsRef, using the turbofish .as_ref_::<_>() syntax. Read more

fn as_mut_<T>(&mut self) -> &mut T
where Self: AsMut<T>, T: ?Sized,

Performs a mutable reference to mutable reference conversion with AsMut, using the turbofish .as_mut_::<_>() syntax. Read more

fn drop_(self)
where Self: Sized,

Drops self using method notation. Alternative to std::mem::drop. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<This> TransmuteElement for This
where This: ?Sized,

unsafe fn transmute_element<T>(self) -> Self::TransmutedPtr
where Self: CanTransmuteElement<T>,

Transmutes the element type of this pointer.. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> TypeIdentity for T
where T: ?Sized,

type Type = T

This is always Self.

fn into_type(self) -> Self::Type
where Self: Sized, Self::Type: Sized,

Converts a value back to the original type.

fn as_type(&self) -> &Self::Type

Converts a reference back to the original type.

fn as_type_mut(&mut self) -> &mut Self::Type

Converts a mutable reference back to the original type.

fn into_type_box(self: Box<Self>) -> Box<Self::Type>

Converts a box back to the original type.

fn into_type_arc(this: Arc<Self>) -> Arc<Self::Type>

Converts an Arc back to the original type. Read more

fn into_type_rc(this: Rc<Self>) -> Rc<Self::Type>

Converts an Rc back to the original type. Read more

fn from_type(this: Self::Type) -> Self
where Self: Sized, Self::Type: Sized,

Converts a value back to the original type.

fn from_type_ref(this: &Self::Type) -> &Self

Converts a reference back to the original type.

fn from_type_mut(this: &mut Self::Type) -> &mut Self

Converts a mutable reference back to the original type.

fn from_type_box(this: Box<Self::Type>) -> Box<Self>

Converts a box back to the original type.

fn from_type_arc(this: Arc<Self::Type>) -> Arc<Self>

Converts an Arc back to the original type.

fn from_type_rc(this: Rc<Self::Type>) -> Rc<Self>

Converts an Rc back to the original type.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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

impl<T> ErasedDestructor for T
where T: 'static,

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

impl<This> ValidTag_Bounds for This
where This: Debug + Clone + PartialEq,