Struct SenderList 

pub struct SenderList {
    patterns: Vec<String>,
    categories: Vec<String>,
    numbers: Vec<String>,
    cards: Vec<String>,
}

A list of who may reach you, one entry per line, # for comments: an address, or a pattern holding * for any run of characters (*@example.org: everyone there; *@*.example.org: its subdomains; news*@example.org; @example.org and a bare example.org stand for *@example.org); a phone number, tel:+33465711234, however written, or a prefix with * (tel:+3319900*); a contact card, contact:<its UID>: all its addresses and numbers, now and later; a category of your contacts, category:Friends. Five such lists exist: the senders you let in (the screener’s), and who is safe, neutral, restricted or blocked (Senders).

Fields

patterns: Vec<String>

Patterns, lower case, as normalize writes them.

categories: Vec<String>

Categories of your contacts, as written (category:Friends).

numbers: Vec<String>

Phone numbers and prefixes, as written after tel:: compared by their key (number_key).

cards: Vec<String>

Contact cards, by their UID (contact:…).

Implementations

impl SenderList

pub fn parse(text: &str) -> Self

pub fn categories(&self) -> &[String]

The categories of your contacts it names, as written.

pub fn numbers(&self) -> &[String]

The numbers and prefixes it names, as written after tel:.

pub fn cards(&self) -> &[String]

The contact cards it names, by their UID.

fn names_category(&self, keys: &[String]) -> Option<&str>

The first of keys (categories as compared, category_key) it names, as written.

fn names_card(&self, uid: &str) -> bool

Whether it names this card (its UID).

fn holds(&self, address: &str) -> bool

Whether it holds this very address (not a pattern that fits it).

fn holds_number(&self, key: &str, region: Option<&Region>) -> bool

Whether it holds this very number (key, as number_key reads it), not a prefix that fits it.

fn prefixes(&self, region: Option<&Region>) -> Vec<String>

Its prefixes, keyed (tel:+3319900*).

pub fn names(&self, address: &str) -> Option<usize>

How precisely the list names an address: its most precise entry that fits it.

pub fn knows(&self, card: &Card) -> bool

pub fn load(path: &Path) -> SenderList

Reads the file; the list is empty when it does not exist yet.

pub fn entries(&self) -> Vec<String>

Every address and pattern: addresses, then patterns, each sorted.

fn rewrite(path: &Path, gone: impl Fn(&str) -> bool) -> Result<(), String>

The file’s lines but those gone names, written beside, then moved: a crash halfway never empties a list, which would let every blocked sender back in. Nothing is written when no line goes. Read and written under the file’s lock, which the sharing takes too.

fn append(path: &Path, line: &str) -> Result<(), String>

A line at the end of the file, the file made if needed.

pub fn remove(path: &Path, entry: &str) -> Result<(), String>

Takes an address or a pattern out of the file, keeping the other lines and the comments; @example.org and *@example.org are the same entry.

pub fn remove_category(path: &Path, name: &str) -> Result<(), String>

Takes a category’s line out of the file, the other lines and the comments kept.

pub fn remove_entry( path: &Path, entry: &Entry, region: Option<&Region>, ) -> Result<(), String>

Takes an entry out of the file, however its line writes it (a number with or without spaces, a category without case or accents), the other lines and the comments kept.

pub fn add_entry( path: &Path, entry: &Entry, region: Option<&Region>, ) -> Result<(), String>

Adds an entry at the end of the file, as Entry::line writes it; nothing when it is already there.

pub fn add_category(path: &Path, name: &str) -> Result<(), String>

Adds a category’s line at the end of the file, as written; nothing when it is already there.

pub fn let_in(path: &Path, entry: &str) -> Result<(), String>

Adds an address or a pattern at the end of the file: lets a sender in, or marks them; nothing when it is already there.

Trait Implementations

impl Clone for SenderList

fn clone(&self) -> SenderList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SenderList

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

Formats the value using the given formatter.

impl Default for SenderList

fn default() -> SenderList

Returns the “default value” for a type.