Struct Surface 

pub struct Surface<T> { /* private fields */ }

A set of keys the source lists, together with whether the list is the whole truth. lookup is the only way to ask about a key: there is no contains, iter, or Deref to the listed set, so a reader cannot take a plain bool from an incomplete surface by accident.

Implementations

impl<T: Ord> Surface<T>

pub fn new(listed: BTreeSet<T>, unreadable: Option<Unreadable>) -> Self

pub fn lookup(&self, key: &T) -> Presence

With no ground, Present or Absent. With ParseTransform, Unknowable for every key. With ExportAll or MacroInExportList, Present for a listed key and Unknowable otherwise: the list under-reports, it does not lie.

pub fn is_complete(&self) -> bool

pub fn listed(&self) -> &BTreeSet<T>

The entries this surface’s source text actually lists: a caller enumerating candidates (rather than asking about one key) reads this instead of guessing the universe.

pub fn merge(&mut self, other: Self)

Combine two surfaces of the same module, as patch_provided does for a cross-file add: a merge with an unreadable side is unreadable on that side’s ground. When both sides are unreadable, ParseTransform wins and otherwise the ground already held is kept.

Trait Implementations

impl<T: Clone> Clone for Surface<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Surface<T>

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

Formats the value using the given formatter.

impl<T> Default for Surface<T>

An empty, fully readable surface: nothing listed, nothing hidden.

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq> Eq for Surface<T>

impl<T: PartialEq> PartialEq for Surface<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Surface<T>