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
impl KnownEnv
Sourcepub fn from_name(name: &str) -> Option<Self>
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.
Sourcepub const fn name(self) -> &'static str
pub const fn name(self) -> &'static str
The canonical name as it appears between \begin{…} braces.
Sourcepub const fn is_aligning(self) -> bool
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§
impl Copy for KnownEnv
impl Eq for KnownEnv
impl StructuralPartialEq for KnownEnv
Auto Trait Implementations§
impl Freeze for KnownEnv
impl RefUnwindSafe for KnownEnv
impl Send for KnownEnv
impl Sync for KnownEnv
impl Unpin for KnownEnv
impl UnsafeUnpin for KnownEnv
impl UnwindSafe for KnownEnv
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more