Enum ContextReference

#[non_exhaustive]
pub enum ContextReference {
    Named(String),
    ByScope {
        scope: Scope,
        sub_context: Option<String>,
        with_escape: bool,
    },
    File {
        name: String,
        sub_context: Option<String>,
        with_escape: bool,
    },
    Inline(String),
    Direct(ContextId),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Named(String)

ByScope

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

scope: Scope

sub_context: Option<String>

with_escape: bool

true if this reference by scope is part of an embed for which there is an escape. In other words a reference for a context for which there “always is a way out”. Enables falling back to Plain Text syntax in case the referenced scope is missing.

File

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

name: String

sub_context: Option<String>

with_escape: bool

Same semantics as for Self::ByScope::with_escape.

Inline(String)

Direct(ContextId)

Implementations

impl ContextReference

pub fn resolve<'a>( &self, syntax_set: &'a SyntaxSet, ) -> Result<&'a Context, ParsingError>

find the pointed to context

pub fn id(&self) -> Result<ContextId, ParsingError>

get the context ID this reference points to

Trait Implementations

impl Clone for ContextReference

fn clone(&self) -> ContextReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContextReference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContextReference

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ContextReference

impl StructuralPartialEq for ContextReference