Struct LocalMembers 

pub struct LocalMembers {
    name: String,
    members: HashSet<String>,
    anchors: HashSet<String>,
    inherited: HashMap<String, Option<PathBuf>>,
    inherited_contracts: HashMap<String, InheritedContract>,
}

Members of the contract page currently being rendered.

Used to resolve {member} and {Contract-member} references lexically: a name that belongs to the current contract links to its heading anchor on the same page instead of going through the global name index (which only contains top-level items and could otherwise resolve to an unrelated page).

Fields

name: String

The current contract’s name.

members: HashSet<String>

Member names with a heading (and thus an anchor) on the current page.

anchors: HashSet<String>

Heading and exact signature anchors rendered on the current page.

inherited: HashMap<String, Option<PathBuf>>

Effective inherited member names and their optional documentation pages.

inherited_contracts: HashMap<String, InheritedContract>

Inherited contracts and the members rendered on their exact pages.

Implementations

impl LocalMembers

pub fn new(name: &str) -> Self

Create an empty member set for the contract name.

pub fn for_contract( gcx: Gcx<'_>, contract_id: ContractId, name_to_page: &NameToPage, ) -> Self

Create a member set populated with members declared by base contracts.

pub fn insert(&mut self, member: &str)

Record a member that is rendered as a ### member heading on the page.

pub fn insert_anchor(&mut self, anchor: String)

Record an exact signature anchor rendered on the current page.

fn member_anchor(&self, member: &str) -> Option<String>

Anchor for a bare {member} reference, if member is documented on this page.

Overloads share the base heading slug; the first heading owns it.

fn xref_member_anchor(&self, part: &str) -> Option<String>

Anchor for a qualified {Contract-member[-params...]} reference, if member is documented on this page.

fn inherited_member_link( &self, member: &str, current_page: &Path, ) -> Option<Option<String>>

Page and anchor for a bare inherited-member reference.

The outer option indicates whether the name is inherited; the inner option is absent when the effective declaration has no rendered page.

fn inherited_contract_member_link( &self, contract: &str, part: &str, current_page: &Path, ) -> Option<Option<String>>

Exact page and anchor for a qualified inherited-contract member reference.

The outer option indicates whether the contract is an inherited base; the inner option is absent when that base has no rendered page or the named member has no rendered heading.

Trait Implementations

impl Debug for LocalMembers

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 216 bytes