Struct mlua_extras::typed::generator::Entry

pub struct Entry<'def> {
    pub docs: Vec<String>,
    pub name: Cow<'def, str>,
    pub ty: Type,
}

Representation of a type that is defined in the definition file.

This type has a name and additional documentation that can be displayed

Fields

docs: Vec<String>

name: Cow<'def, str>

ty: Type

Implementations

impl<'def> Entry<'def>

pub fn new(name: impl Into<Cow<'def, str>>, ty: Type) -> Self

Create a new definition entry without documentation

pub fn new_with<S: AsRef<str>>( name: impl Into<Cow<'def, str>>, ty: Type, docs: impl IntoIterator<Item = S>, ) -> Self

Create a new definition entry with documentation

Trait Implementations

impl<'def> Clone for Entry<'def>

fn clone(&self) -> Entry<'def>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'def> Debug for Entry<'def>

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

Formats the value using the given formatter.

impl<'def> Ord for Entry<'def>

fn cmp(&self, other: &Entry<'def>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'def> PartialEq for Entry<'def>

fn eq(&self, other: &Entry<'def>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'def> PartialOrd for Entry<'def>

fn partial_cmp(&self, other: &Entry<'def>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'def> Eq for Entry<'def>

impl<'def> StructuralPartialEq for Entry<'def>