Struct kvarn::extensions::Id

pub struct Id { /* private fields */ }

A extension Id. The Self::priority is used for sorting extensions and Self::name for debugging which extensions are mounted.

Higher priority extensions are ran first. The debug name is useful when you want to see which priorities other extensions use. This is beneficial when creating “plug-and-play” extensions.

If two extensions with identical prioritys are inserted, the latter will override the prior. This only effects extensions of the same type.

Implementations

impl Id

pub fn new(priority: i32, name: &'static str) -> Self

Creates a new Id with priority and a name.

pub fn without_name(priority: i32) -> Self

Creates a Id without a name. This is considered a bad practice, as you cannot see which extensions are mounted to the Extensions.

See Self::name for details about how this affects output.

pub fn no_override(self) -> Self

Always inserts this extension. If an extension with the same priority exist, the priority is decremented and tried again.

pub fn name(&self) -> &'static str

Returns the name of this Id.

If the Id is created with Self::without_name, this returns Unnamed.

pub fn priority(&self) -> i32

Returns the priority of this extension.

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl Display for Id

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

Formats the value using the given formatter.

impl Ord for Id

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Id> for Id

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Id> for Id

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Id

impl Eq for Id