Skip to main content

CopyOptions

Struct CopyOptions 

Source
pub struct CopyOptions {
    pub format: CopyFormat,
    pub header: bool,
    pub delimiter: Option<char>,
    pub null_str: Option<String>,
    pub quote: Option<char>,
    pub escape: Option<char>,
    pub force_quote: Option<Vec<String>>,
    pub force_not_null: Option<Vec<String>>,
    pub force_null: Option<Vec<String>>,
}
Expand description

Options for COPY … TO STDOUT [WITH] (…). Defaults reproduce the bare COPY … TO STDOUT text-format behaviour, so an empty option list is a no-op. delimiter / null_str / quote fall back to the per-format defaults (text: \t / \N; csv: , / `` / ") when unset.

Fields§

§format: CopyFormat§header: bool§delimiter: Option<char>§null_str: Option<String>§quote: Option<char>§escape: Option<char>

v7.39 (round 247) — CSV ESCAPE: the character that precedes a quote (or itself) inside a quoted cell. Defaults to the quote character (PG’s doubling behavior).

§force_quote: Option<Vec<String>>

v7.39 (round 247) — CSV FORCE_QUOTE (col, …) / FORCE_QUOTE *: columns whose non-NULL cells always quote. Some(vec![]) is the * spelling (every column).

§force_not_null: Option<Vec<String>>

v7.39 (round 265) — CSV FORCE_NOT_NULL (col, …): for these columns an UNQUOTED empty field reads as the empty string rather than NULL (probed). COPY FROM only.

§force_null: Option<Vec<String>>

v7.39 (round 265) — CSV FORCE_NULL (col, …): for these columns a QUOTED empty field ("") also reads as NULL (probed). COPY FROM only.

Trait Implementations§

Source§

impl Clone for CopyOptions

Source§

fn clone(&self) -> CopyOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CopyOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CopyOptions

Source§

fn default() -> CopyOptions

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

impl Eq for CopyOptions

Source§

impl PartialEq for CopyOptions

Source§

fn eq(&self, other: &CopyOptions) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CopyOptions

Auto Trait Implementations§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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.