Struct artichoke_backend::state::parser::Context

pub struct Context { /* fields omitted */ }

Context is used to manipulate the current filename on the parser.

Parser State maintains a stack of Contexts and eval uses the Context stack to set the __FILE__ magic constant.

Implementations

impl Context

pub fn new<T>(filename: T) -> Option<Self> where
    T: Into<Cow<'static, [u8]>>, 

Create a new Context.

pub unsafe fn new_unchecked<T>(filename: T) -> Self where
    T: Into<Cow<'static, [u8]>>, 

Create a new Context without checking for NUL bytes in the filename.

Safety

filename must not contain any NUL bytes. filename must not contain a trailing NUL.

#[must_use]pub fn root() -> Self

Create a root, or default, Context.

The root context sets the __FILE__ magic constant to "(eval)".

#[must_use]pub fn filename(&self) -> &[u8]

Filename of this Context.

#[must_use]pub fn filename_as_c_str(&self) -> &CStr

FFI-safe NUL-terminated C String of this Context.

This CStr is valid as long as this Context is not dropped.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Context

impl Hash for Context

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Context

fn cmp(&self, other: &Context) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Context> for Context

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Context> for Context

fn partial_cmp(&self, other: &Context) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Context) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Context) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Context) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Context) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Context

impl StructuralPartialEq for Context