Skip to main content

EnvironmentDecl

Struct EnvironmentDecl 

Source
pub struct EnvironmentDecl {
    pub like: Option<SmolStr>,
    pub begin: Vec<CommandName>,
    pub end: Vec<CommandName>,
}
Expand description

One [environments.<name>] entry: what the environment named by the key behaves like, and which command spellings stand in for its delimiters.

The key is the environment’s own name, whether or not it is one the built-in database knows. That is what lets a single entry serve both shapes the issue asked for — \begin{myenv} … \end{myenv} needing only behavior, and \startmyenv … \endmyenv needing behavior and spellings — without a union-typed entry.

Fields§

§like: Option<SmolStr>

The curated built-in environment whose behavior this one copies — math, alignment, list-ness, verbatim-ness, and every flag added later.

Resolved against the built-in database alone, never the CWL tier or scanned definitions, for the same reason the alias arm of Signatures::environment_at is: a declaration supplies a spelling, and behavior always comes from curated data. An unknown target is an error rather than a silent no-op, because a mistyped like = "algin" is otherwise invisible.

§begin: Vec<CommandName>

Command spellings that stand in for this environment’s \begin{…} (\bea, \startmyenv). Any of them opens the environment; the closers in end close it — and so does the literal \end{…}, which is why either list may stand alone (issue #117).

§end: Vec<CommandName>

Command spellings that stand in for this environment’s \end{…}. Kept a separate list rather than begin/end tuples because pairing is by kind, not by index: \bea … \eea pairs whichever spellings the author used.

Implementations§

Source§

impl EnvironmentDecl

Source

pub fn has_delimiters(&self) -> bool

Whether this entry declares delimiter spellings (as opposed to behavior alone).

Trait Implementations§

Source§

impl Clone for EnvironmentDecl

Source§

fn clone(&self) -> EnvironmentDecl

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 EnvironmentDecl

Source§

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

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

impl Default for EnvironmentDecl

Source§

fn default() -> EnvironmentDecl

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for EnvironmentDecl

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for EnvironmentDecl

Source§

impl Hash for EnvironmentDecl

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for EnvironmentDecl

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EnvironmentDecl

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EnvironmentDecl

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.