Enum State

pub enum State {
    Unstable,
    Stable,
    Deprecated {
        since: String,
        notice: String,
    },
}

Must be set on all archetypes and components

Variants

Unstable

Used for types that are likely to be removed or changed significantly, and in a way that the data won’t be backwards compatible.

Stable

Used for types that are unlikely to be removed or changed significantly. If they are changed, we will make sure that the old data can still be read.

Deprecated

Marks something as deprecated followed by a (mandatory!) migration note.

If specified on an object (struct/enum/union), it becomes deprecated such that using the object should emit a warning in all target languages. Furthermore, documentation will mention that the object is deprecated and display the specified migration note.

Fields

since: String

notice: String

Implementations

impl State

pub fn from_attrs(attrs: &Attributes) -> Result<Self, String>

pub fn docline_summary(&self) -> Option<String>

Add noteworthy information on a single line, if any.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl PartialEq for State

fn eq(&self, other: &State) -> 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 Eq for State

impl StructuralPartialEq for State