Skip to main content

Declarations

Struct Declarations 

Source
pub struct Declarations {
    pub environments: EnvironmentDecls,
}
Expand description

Every declaration a project makes, as authored — unresolved and unvalidated.

BTreeMap rather than HashMap so iteration order is deterministic: resolution reports errors in the order the user reads them, and the value ends up on a salsa input whose equality must not depend on hash order.

Fields§

§environments: EnvironmentDecls

The [environments.<name>] entries.

Implementations§

Source§

impl Declarations

Source

pub fn is_empty(&self) -> bool

Whether the project declares nothing at all — the overwhelmingly common case, and the one the parse must not pay anything for.

Source

pub fn resolve(&self) -> Result<ResolvedDeclarations, DeclarationError>

Check every rule and project the declarations into a ResolvedDeclarations: an environment signature per like, and the delimiter spellings as opener and closer alias entries.

Internally a SignatureDb, because that is already the shape holding exactly these three maps: the declared tier folds into a document’s scope with the existing SignatureDb::merge_from, and the ParseCtx seed reads it the same way it already reads the per-file scan’s — no new plumbing, and [commands.*] slots in later without changing the signature of this function.

Every failure is an error, never a silent no-op. A declaration that quietly does nothing is the worst outcome available here: the user sees unchanged output and has no way to tell a typo from an unimplemented feature. Errors surface in key order (the map is a BTreeMap), so the message is stable across runs.

An entry that declares behavior alone is unrestricted — like = "lstlisting" is exactly how a project names a verbatim environment the definition scan cannot find. The extra restrictions below apply only to an entry that declares delimiter spellings, since those are the ones a command has to stand in for. An entry that declares nothing is the one shape rejected for saying too little rather than too much.

Trait Implementations§

Source§

impl Clone for Declarations

Source§

fn clone(&self) -> Declarations

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 Declarations

Source§

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

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

impl Default for Declarations

Source§

fn default() -> Declarations

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

impl<'de> Deserialize<'de> for Declarations

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 Declarations

Source§

impl Hash for Declarations

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 Declarations

Source§

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

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 Declarations

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.