Struct Context

pub struct Context(/* private fields */);

Wolfram Language context.

Examples: System`, Global`, MyPackage`Utils`, etc.

Implementations

impl Context

pub fn try_new(input: &str) -> Option<Self>

Attempt to parse input as a context.

pub fn new(input: &str) -> Self

Construct a context from input.

Panics

This function will panic if input is not a valid Wolfram Language context. Context::try_new(input) must succeed.

This method is intended to be used for convenient construction of contexts from string literals, where an error is unlikely to occur, e.g.:

use wolfram_expr::symbol::Context;

let context = Context::new("MyPackage`");

If not using a string literal as the argument, prefer to use Context::try_new and handle the error condition.

pub fn global() -> Self

The Global` context.

pub fn system() -> Self

The System` context.

pub fn join(&self, name: SymbolNameRef<'_>) -> Context

Construct a new Context by appending a new context component to this context.

use wolfram_expr::symbol::{Context, SymbolName, SymbolNameRef};

let context = Context::from_symbol_name(&SymbolName::try_new("MyContext").unwrap());
let private = context.join(SymbolNameRef::try_new("Private").unwrap());

assert!(private.as_str() == "MyContext`Private`");

pub fn components(&self) -> Vec<SymbolNameRef<'_>>

Return the components of this Context.

use wolfram_expr::symbol::Context;

let context = Context::new("MyPackage`Sub`Module`");

let components = context.components();

assert!(components.len() == 3);
assert!(components[0].as_str() == "MyPackage");
assert!(components[1].as_str() == "Sub");
assert!(components[2].as_str() == "Module");

pub fn as_context_ref(&self) -> ContextRef<'_>

Get a borrowed ContextRef from this Context.

pub fn from_symbol_name(name: &SymbolName) -> Self

Create the context name`.

impl Context

pub fn as_str(&self) -> &str

Get the underlying &str representation of this type.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

const 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 Display for Context

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

Formats the value using the given formatter.

impl Hash for Context

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Context

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Context

impl StructuralPartialEq for Context