Struct PisaToCiff 

pub struct PisaToCiff { /* private fields */ }

PISA to CIFF converter.

Implementations

impl PisaToCiff

pub fn description<S: Into<String>>(&mut self, description: S) -> &mut Self

Sets CIFF index description.

pub fn pisa_paths<P: AsRef<OsStr>>(&mut self, base_path: P) -> &mut Self

Sets PISA paths. Required.

Paths are constructed by appending file extensions to the base path:

• .docs for document postings,
• .freqs for frequency postings,
• .sizes for document sizes,
• .terms for terms text file,
• .documents for document titles text file,

pub fn index_paths<P: AsRef<OsStr>>(&mut self, base_path: P) -> &mut Self

Sets PISA (uncompressed) inverted index paths. Required.

Constructs paths using the given base path, appeding suffixes: .docs, .freqs, and .sizes.

pub fn terms_path<P: Into<PathBuf>>(&mut self, path: P) -> &mut Self

Sets the path of the term file (newline-delimited text format). Required.

pub fn titles_path<P: Into<PathBuf>>(&mut self, path: P) -> &mut Self

Sets the path of the document titles file (newline-delimited text format). Required.

pub fn output_path<P: Into<PathBuf>>(&mut self, path: P) -> &mut Self

Set the output file path. Required.

pub fn convert(&self) -> Result<()>

Builds a CIFF index using the previously defined parameters.

Errors

Error will be returned if:

• some required parameters are not defined,
• any I/O error occurs during reading input files or writing to the output file,
• any input file is in an incorrect format.

Trait Implementations

impl Clone for PisaToCiff

fn clone(&self) -> PisaToCiff

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PisaToCiff

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

Formats the value using the given formatter.

impl Default for PisaToCiff

fn default() -> PisaToCiff

Returns the “default value” for a type.