Struct RstDomain

pub struct RstDomain { /* private fields */ }

RST domain validator for document and section references

Implementations

impl RstDomain

pub fn new() -> Self

Create a new RST domain

pub fn register_document( &mut self, docname: String, title: String, location: ReferenceLocation, ) -> Result<(), BuildError>

Register a document

pub fn register_section( &mut self, label: String, title: String, docname: String, location: ReferenceLocation, ) -> Result<(), BuildError>

Register a section (for :ref: targets)

pub fn register_label( &mut self, label: String, label_type: String, title: Option<String>, docname: String, location: ReferenceLocation, ) -> Result<(), BuildError>

Register a figure or table label

Trait Implementations

impl Default for RstDomain

fn default() -> Self

Returns the “default value” for a type.

impl DomainValidator for RstDomain

fn domain_name(&self) -> &str

Get the name of this domain

fn supported_reference_types(&self) -> Vec<ReferenceType>

Get the reference types this domain handles

fn register_object(&mut self, object: DomainObject) -> Result<(), BuildError>

Register a domain object

fn resolve_reference(&self, reference: &CrossReference) -> Option<DomainObject>

Resolve a reference to a domain object

fn validate_reference( &self, reference: &CrossReference, ) -> ReferenceValidationResult

Validate a cross-reference

fn get_all_objects(&self) -> Vec<&DomainObject>

Get all objects in this domain

fn clear_objects(&mut self)

Clear all registered objects (for rebuilds)