Skip to main content

KnownEnv

Enum KnownEnv 

Source
pub enum KnownEnv {
Show 17 variants Align, AlignStar, Aligned, Equation, EquationStar, Gather, GatherStar, Matrix, Pmatrix, Bmatrix, Vmatrix, Smallmatrix, Cases, Array, Split, Multline, MultlineStar,
}
Expand description

Standard environments recognised by math canonicalisation. Names follow amsmath conventions; the starred variants are the unnumbered forms.

Variants§

§

Align

§

AlignStar

§

Aligned

§

Equation

§

EquationStar

§

Gather

§

GatherStar

§

Matrix

§

Pmatrix

§

Bmatrix

§

Vmatrix

§

Smallmatrix

§

Cases

§

Array

§

Split

§

Multline

§

MultlineStar

Implementations§

Source§

impl KnownEnv

Source

pub fn from_name(name: &str) -> Option<Self>

Resolve an environment name to a known variant. Returns None for any name outside the standard set; the caller falls back to EnvKind::Custom.

Source

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

The canonical name as it appears between \begin{…} braces.

Source

pub const fn is_aligning(self) -> bool

Whether rows in this environment are organised by & column separators that should be aligned by canonicalisation. equation, gather, and multline are vertical-list environments without column alignment.

Trait Implementations§

Source§

impl Clone for KnownEnv

Source§

fn clone(&self) -> KnownEnv

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 KnownEnv

Source§

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

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

impl PartialEq for KnownEnv

Source§

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

Source§

impl Eq for KnownEnv

Source§

impl StructuralPartialEq for KnownEnv

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more