Struct Domain

pub struct Domain {
    pub name: String,
    pub label: String,
    pub object_types: HashMap<String, ObjectType>,
    pub objects: HashMap<String, Vec<DomainObject>>,
    pub indices: Vec<DomainIndex>,
}

Domain represents a Sphinx domain (py, cpp, js, std, etc.)

Fields

name: String

label: String

object_types: HashMap<String, ObjectType>

objects: HashMap<String, Vec<DomainObject>>

indices: Vec<DomainIndex>

Implementations

impl Domain

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

pub fn add_object(&mut self, obj_type: &str, object: DomainObject)

pub fn get_objects(&self) -> Vec<&DomainObject>

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

pub fn get_objects_by_type(&self, obj_type: &str) -> Option<&Vec<DomainObject>>

Trait Implementations

impl Clone for Domain

fn clone(&self) -> Domain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Domain

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

Formats the value using the given formatter.