Skip to main content

ImportOptions

Struct ImportOptions 

Source
pub struct ImportOptions {
    pub file: PathBuf,
    pub target: String,
    pub admin_token: String,
    pub apply: bool,
    pub merge_by_email: bool,
    pub report: Option<PathBuf>,
    pub batch_size: usize,
}
Expand description

Everything run needs, assembled by the dispatcher so the token is read from the environment exactly once and travels no further than the request header.

Fields§

§file: PathBuf

The JSONL file of user objects.

§target: String

The venture’s base URL; IMPORT_PATH is appended.

§admin_token: String

The ADMIN_TOKEN value, read from the variable --admin-token-env names. Never printed.

§apply: bool

--apply: write. Absent, the run is a dry run.

§merge_by_email: bool

--merge-by-email: let the server merge into an existing account sharing the email.

§report: Option<PathBuf>

--report: where the report JSONL goes. Defaults to <file>.report.jsonl.

§batch_size: usize

Users per request.

Implementations§

Source§

impl ImportOptions

Source

pub fn dry_run(&self) -> bool

Whether this run asks the server to change nothing. --apply is the only way to make it false.

Source

pub fn report_path(&self) -> PathBuf

Where the report is written: --report, or <file>.report.jsonl.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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