Struct email::notmuch::config::NotmuchConfig

pub struct NotmuchConfig {
    pub database_path: Option<PathBuf>,
    pub maildir_path: Option<PathBuf>,
    pub config_path: Option<PathBuf>,
    pub profile: Option<String>,
}

The Notmuch backend config.

Fields

database_path: Option<PathBuf>

The path to the Notmuch database.

The path should point to the root directory containing the Notmuch database (usually the root Maildir directory). Path is shell-expanded, which means environment variables and tilde ~ are replaced by their values.

maildir_path: Option<PathBuf>

Override the default path to the Maildir folder.

Path is shell-expanded, which means environment variables and tilde ~ are replaced by their values. Defaults to database_path if omitted.

config_path: Option<PathBuf>

Override the default Notmuch configuration file path.

Path is shell-expanded, which means environment variables and tilde ~ are replaced by their values.

profile: Option<String>

Override the default Notmuch profile name.

Implementations

impl NotmuchConfig

pub fn get_default_database_path() -> Result<PathBuf>

Get the default Notmuch database path.

pub fn try_get_database_path(&self) -> Result<PathBuf>

Try to get the reference to the Notmuch database path.

pub fn try_get_maildir_path(&self) -> Result<PathBuf>

Try to get the reference to the Maildir path.

Tries maildir_path first, otherwise falls back to database_path.

pub fn find_config_path(&self) -> Option<&Path>

Find the Notmuch configuration path reference.

pub fn find_profile(&self) -> Option<&str>

Find the Notmuch profile.

Trait Implementations

impl Clone for NotmuchConfig

fn clone(&self) -> NotmuchConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NotmuchConfig

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

Formats the value using the given formatter.

impl Default for NotmuchConfig

fn default() -> NotmuchConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NotmuchConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NotmuchConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NotmuchConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for NotmuchConfig

impl StructuralPartialEq for NotmuchConfig