Struct Import 

pub struct Import { /* private fields */ }

A CSV file to import; see the module docs.

Implementations

impl Import

pub fn csv(data: impl AsRef<[u8]>) -> Self

The bytes of a CSV file (an upload’s, a file’s): UTF-8, with or without a byte order mark, its first line naming the columns.

pub fn delimiter(self, delimiter: char) -> Self

Cells are separated by delimiter (; in files from a spreadsheet set to a European language) instead of ,.

pub fn headers(self, names: &[&str]) -> Self

The file has no line of column names: these are its columns, in order.

pub fn rename(self, heading: &str, field: &str) -> Self

Reads the column headed heading as the field field, e.g. rename("Description", "name"). Without one, a heading names its field in lowercase with _ for spaces and dashes: “Unit price” is unit_price.

pub fn max_rows(self, rows: usize) -> Self

At most rows rows (default MAX_IMPORT_ROWS); a longer file is refused before anything is written.

pub fn all_or_nothing(self) -> Self

Writes nothing unless every row is valid and saved: one bad row and the whole file is refused (the report lists why). By default the good rows are written and the bad ones reported.

pub fn lang(self, lang: &Lang) -> Self

Messages (and the report) in this language; the app’s APP_LOCALE otherwise.

pub fn user(self, user: &User) -> Self

The user importing, whom the rows’ after hooks see as form.user (and the current_password rule checks).

pub fn field(self, name: &str) -> Self

The form field the file came in (file by default): a file that can’t be read is reported as that field’s error.

pub fn run<'a, T, F>( self, state: &'a AppState, write: F, ) -> impl Future<Output = Result<ImportReport>> + Send + 'a

where T: DeserializeOwned + Validate + Send + Sync + 'a, F: for<'t> FnMut(&'t mut Transaction, T) -> BoxFuture<'t, Result> + Send + 'a,

Reads every row into a T and checks it with T’s rules (its prepare and after hooks too), then calls write with each valid row inside one transaction, a savepoint per row. An error from write is that row’s failure: a ValidationError shows its messages, Error::BadRequest its text, a unique-constraint violation says the row repeats a unique value.

T’s authorize hook isn’t asked: authorize the import’s route.