Struct CatalogBuilder 

pub struct CatalogBuilder<'a> { /* private fields */ }

A builder for constructing a Catalog.

CatalogBuilder allows control over the process of constructing a Catalog. If the default options are acceptable, Catalog::new bypasses the need for CatalogBuilder.

Implementations

impl<'a> CatalogBuilder<'a>

pub fn new() -> Self

Constructs a new CatalogBuilder with default settings.

pub fn build(self) -> Catalog

Builds a Catalog and chooses a default paper size by reading the by reading paperspecs and papersize files and examining the environment and (on GNU/Linux) locale.

If no system or user paperspecs files exist, or if they exist but they contain no valid paper specifications, then this method uses the standard paper sizes in STANDARD_PAPERSPECS. This is usually a reasonable fallback.

pub fn build_from_fallback(self) -> Catalog

Builds a Catalog from STANDARD_PAPERSPECS and chooses a default paper size by reading the by reading papersize files and examining the environment and (on GNU/Linux) locale.

This is a reasonable choice if it is unlikely for paperspecs to be installed but it is still desirable to detect a default paper size.

pub fn build_without_fallback(self) -> Option<Catalog>

Tries to build a Catalog and chooses a default paper size by reading the by reading paperspecs and papersize files and examining the environment and (on GNU/Linux) locale.

If no system or user paperspecs files exist, or if they exist but they contain no valid paper specifications, this method fails and returns None.

pub fn with_papersize_value(self, papersize: Option<&'a str>) -> Self

Sets papersize to be used for the value of the PAPERSIZE environment variable, instead of obtaining it from the process environment. None means that the environment variable is assumed to be empty or absent.

pub fn without_locale(self) -> Self

On GNU/Linux, by default, CatalogBuilder will consider the paper size setting in the glibc locale LC_PAPER. This method disables this feature.

This setting has no effect on other operating systems, which do not support paper size as part of their locales.

pub fn with_user_config_dir(self, user_config_dir: Option<&'a Path>) -> Self

Overrides the name of the user-specific configuration directory.

This directory is searched for the user-specified paperspecs and papersize files. It defaults to $XDG_CONFIG_HOME, which is usually $HOME/.config.

Passing None will disable reading paperspec or papersize from the user configuration directory.

pub fn with_system_config_dir(self, system_config_dir: Option<&'a Path>) -> Self

Overrides the name of the system configuration directory.

This directory is searched for the system paperspecs and papersize files. It defaults to /etc.

Passing None will disable reading paperspec or papersize from the system configuration directory.

pub fn with_error_callback( self, error_cb: Box<dyn FnMut(CatalogBuildError) + 'a>, ) -> Self

Sets an error reporting callback.

By default, CatalogBuilder ignores errors while building the catalog. The error_cb callback allows the caller to receive information about these errors.

It is not considered an error if paperspecs or papersize files do not exist.

Trait Implementations

impl<'a> Default for CatalogBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.