Skip to main content

RegAlgorithm

Enum RegAlgorithm 

Source
pub enum RegAlgorithm {
    DaleReiter,
    GraphBased,
}
Expand description

Selects the REG (Referring Expression Generation) algorithm used by the {name|refer} pipe when rendering the Full form of a reference.

The default is DaleReiter, which matches the historical behaviour of the engine.

Variants§

§

DaleReiter

Dale & Reiter 1995 Incremental Algorithm.

Disambiguates same-type entities using unary attributes only — e.g. “the domain class UserService” vs “the infra class AuthService”. Fast, well-understood, and the default.

§

GraphBased

Krahmer et al. 2003 graph-based greedy algorithm.

Handles both unary attributes AND binary relations between entities. When attributes alone do not disambiguate, the algorithm appends one relation clause — e.g. “the api function LoginHandler that calls AuthService”. Falls back silently to D&R behaviour when no relations are registered.

Trait Implementations§

Source§

impl Clone for RegAlgorithm

Source§

fn clone(&self) -> RegAlgorithm

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RegAlgorithm

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RegAlgorithm

Source§

fn default() -> RegAlgorithm

Returns the “default value” for a type. Read more
Source§

impl PartialEq for RegAlgorithm

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for RegAlgorithm

Source§

impl Eq for RegAlgorithm

Source§

impl StructuralPartialEq for RegAlgorithm

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.