Struct DocumentationRegistrant 

pub struct DocumentationRegistrant { /* private fields */ }

Process-wide registry of routes and documentation settings.

Holds the base path, global rate limit, auth settings, group descriptions, registered routes, global headers, test HTTP clients, and the DocumentationMode. Starts with base path "/", no rate limit, Conventional mode, and the three built-in HTTP clients.

Access the shared instance via global, get_instance, or get_instance_mut.

Implementations

impl DocumentationRegistrant

pub fn global() -> &'static RwLock<Self>

Returns the shared registry, creating it on first use.

pub fn get_instance() -> RwLockReadGuard<'static, Self>

Returns a read guard for the shared registry.

Panics if the lock is poisoned.

pub fn get_instance_mut() -> RwLockWriteGuard<'static, Self>

Returns a write guard for the shared registry.

Panics if the lock is poisoned.

pub fn bind_base(&mut self, base: impl Into<String>)

Sets the base path used for the generated servers entries.

An empty value resets the base path to "/".

pub fn bind_base_list(&mut self, roots: &[String])

Sets the base path from a list of roots, using the first entry.

Falls back to "/" when the list is empty.

pub fn base_path(&self) -> &str

Returns the currently configured base path.

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

Returns all configured mount/bind paths used as OpenAPI server paths.

pub fn set_global_rate_limit(&mut self, limit: Option<u32>)

Sets the global rate limit in requests per minute (None means unlimited).

pub fn get_global_rate_limit(&self) -> Option<u32>

Returns the global rate limit in requests per minute, if set.

pub fn set_auth_settings(&mut self, m: HashMap<String, String>)

Replaces the authentication settings map used in the spec description and security schemes.

pub fn get_auth_settings(&self) -> &HashMap<String, String>

Returns the authentication settings map.

pub fn set_global_headers(&mut self, headers: HashMap<String, String>)

Sets the legacy shared global headers bucket.

pub fn set_global_headers_scoped( &mut self, headers: HashMap<String, String>, authenticated_only: bool, )

Sets scoped global headers: the authenticated bucket when authenticated_only is true, otherwise the unauthenticated bucket.

pub fn get_global_headers(&self) -> HashMap<String, String>

Returns legacy, unauthenticated, and authenticated headers merged together.

Later buckets overwrite earlier ones on key conflicts.

pub fn get_authenticated_global_headers(&self) -> HashMap<String, String>

Returns legacy plus authenticated headers merged together.

pub fn get_authenticated_only_headers(&self) -> &HashMap<String, String>

Returns only headers configured for authenticated requests.

pub fn get_unauthenticated_global_headers(&self) -> HashMap<String, String>

Returns legacy plus unauthenticated headers merged together.

pub fn set_documentation_mode(&mut self, mode: DocumentationMode)

Sets the DocumentationMode controlling docs visibility in production.

pub fn get_documentation_mode(&self) -> DocumentationMode

Returns the current DocumentationMode.

pub fn register_http_client(&mut self, client: Arc<dyn DocHttpClient>)

Adds an extra DocHttpClient to the test-execution client list.

pub fn get_http_clients(&self) -> Vec<Arc<dyn DocHttpClient>>

Returns all registered test-execution HTTP clients.

pub fn set_group_description( &mut self, group: impl Into<String>, desc: impl Into<String>, )

Sets the description for one documentation group (tag).

pub fn set_group_descriptions(&mut self, descriptions: HashMap<String, String>)

Replaces all group descriptions, keeping only entries with a non-empty trimmed name and storing trimmed names and values.

pub fn get_group_description(&self, group: &str) -> String

Returns the description for a group, or "N/A" when missing or blank.

pub fn get_group_descriptions(&self) -> &HashMap<String, String>

Returns all group descriptions keyed by group name.

pub fn register_route( &mut self, path: &str, method: &str, controller_class: &str, description: RouteDescription, )

Records one route with its path, method, controller name, and metadata.

pub fn get_registered_routes(&self) -> &[RegisteredRoute]

Returns all registered routes in registration order.

pub fn clear(&mut self)

Removes all registered routes; other settings are left unchanged.

Trait Implementations

impl Default for DocumentationRegistrant

fn default() -> Self

Returns the “default value” for a type.