Skip to main content

ChapelModule

Struct ChapelModule 

Source
pub struct ChapelModule {
    pub name: Option<String>,
    pub uses: Vec<String>,
    pub requires: Vec<String>,
    pub globals: Vec<(String, ChapelType, ChapelExpr)>,
    pub configs: Vec<(String, ChapelType, Option<ChapelExpr>)>,
    pub procs: Vec<ChapelProc>,
    pub records: Vec<ChapelRecord>,
    pub classes: Vec<ChapelClass>,
    pub submodules: Vec<ChapelModule>,
    pub doc: Option<String>,
}
Expand description

A Chapel source module (single .chpl file).

Fields§

§name: Option<String>

Module name (None = implicit top-level)

§uses: Vec<String>

use imports

§requires: Vec<String>

require directives

§globals: Vec<(String, ChapelType, ChapelExpr)>

Top-level constant declarations

§configs: Vec<(String, ChapelType, Option<ChapelExpr>)>

Top-level config variable declarations

§procs: Vec<ChapelProc>

Top-level procedures

§records: Vec<ChapelRecord>

Top-level record definitions

§classes: Vec<ChapelClass>

Top-level class definitions

§submodules: Vec<ChapelModule>

Sub-modules

§doc: Option<String>

Module-level doc comment

Implementations§

Source§

impl ChapelModule

Source

pub fn new() -> Self

Create an empty unnamed module.

Source

pub fn named(name: impl Into<String>) -> Self

Create a named module.

Source

pub fn add_use(&mut self, name: impl Into<String>)

Add a use directive.

Source

pub fn add_require(&mut self, path: impl Into<String>)

Add a require directive.

Source

pub fn add_global( &mut self, name: impl Into<String>, ty: ChapelType, expr: ChapelExpr, )

Add a top-level constant.

Source

pub fn add_config( &mut self, name: impl Into<String>, ty: ChapelType, default: Option<ChapelExpr>, )

Add a config variable.

Source

pub fn add_proc(&mut self, proc: ChapelProc)

Add a procedure.

Source

pub fn add_record(&mut self, rec: ChapelRecord)

Add a record.

Source

pub fn add_class(&mut self, cls: ChapelClass)

Add a class.

Source

pub fn set_doc(&mut self, doc: impl Into<String>)

Set the doc comment.

Trait Implementations§

Source§

impl Clone for ChapelModule

Source§

fn clone(&self) -> ChapelModule

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChapelModule

Source§

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

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

impl Default for ChapelModule

Source§

fn default() -> Self

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

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> 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.