Struct sway_core::semantic_analysis::namespace::Module

source · [−]

pub struct Module { /* private fields */ }

Expand description

A single Module within a Sway project.

A Module is most commonly associated with an individual file of Sway code, e.g. a top-level script/predicate/contract file or some library dependency whether introduced via dep or the [dependencies] table of a forc manifest.

A Module contains a set of all items that exist within the lexical scope via declaration or importing, along with a map of each of its submodules.

Implementations

source

impl Module

source

pub fn default_with_constants(
constants: BTreeMap<String, ConfigTimeConstant>
) -> Result<Self, Vec1<CompileError>>

source

pub fn submodules(&self) -> &OrdMap<String, Module>

Immutable access to this module’s submodules.

source

pub fn insert_submodule(&mut self, name: String, submodule: Module)

Insert a submodule into this Module.

source

pub fn submodule(&self, path: &Path) -> Option<&Module>

Lookup the submodule at the given path.

source

pub fn submodule_mut(&mut self, path: &Path) -> Option<&mut Module>

Unique access to the submodule at the given path.

Methods from Deref<Target = Items>

source

pub fn symbols(&self) -> &OrdMap<Ident, TypedDeclaration>

Immutable access to the inner symbol map.

source

pub fn apply_storage_load(
 &self,
 fields: Vec<Ident>,
 storage_fields: &[TypedStorageField]
) -> CompileResult<(TypeCheckedStorageAccess, TypeId)>

source

pub fn set_storage_declaration(
&mut self,
decl: TypedStorageDeclaration
) -> CompileResult<()>

source

pub fn get_all_declared_symbols(&self) -> impl Iterator<Item = &Ident>

Trait Implementations

source

impl Clone for Module

source

fn clone(&self) -> Module

Returns a copy 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 Module

source

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

Formats the value using the given formatter. Read more

source

impl Default for Module

source

fn default() -> Module

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

source

impl Deref for Module

type Target = Items

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

impl DerefMut for Module

source

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

source

impl From<Module> for Root

source

fn from(module: Module) -> Self

Converts to this type from the input type.

source

impl From<Root> for Module

source

fn from(root: Root) -> Self

Converts to this type from the input type.

source

impl<'a> Index<&'a [Ident]> for Module

type Output = Module

The returned type after indexing.

source

fn index(&self, path: &'a Path) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

source

impl<'a> IndexMut<&'a [Ident]> for Module

source

fn index_mut(&mut self, path: &'a Path) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more

source

impl PartialEq<Module> for Module

source

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl StructuralPartialEq for Module

Auto Trait Implementations

impl RefUnwindSafe for Module

impl Send for Module

impl Sync for Module

impl Unpin for Module

impl UnwindSafe for Module

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct sway_core::semantic_analysis::namespace::Module

Implementations

impl Module

pub fn default_with_constants( constants: BTreeMap<String, ConfigTimeConstant>) -> Result<Self, Vec1<CompileError>>

pub fn submodules(&self) -> &OrdMap<String, Module>

pub fn insert_submodule(&mut self, name: String, submodule: Module)

pub fn submodule(&self, path: &Path) -> Option<&Module>

pub fn submodule_mut(&mut self, path: &Path) -> Option<&mut Module>

Methods from Deref<Target = Items>

pub fn symbols(&self) -> &OrdMap<Ident, TypedDeclaration>

pub fn apply_storage_load( &self, fields: Vec<Ident>, storage_fields: &[TypedStorageField]) -> CompileResult<(TypeCheckedStorageAccess, TypeId)>

pub fn set_storage_declaration( &mut self, decl: TypedStorageDeclaration) -> CompileResult<()>

pub fn get_all_declared_symbols(&self) -> impl Iterator<Item = &Ident>

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

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

impl Debug for Module

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

impl Default for Module

fn default() -> Module

impl Deref for Module

type Target = Items

fn deref(&self) -> &Self::Target

impl DerefMut for Module

fn deref_mut(&mut self) -> &mut Self::Target

impl From<Module> for Root

fn from(module: Module) -> Self

impl From<Root> for Module

fn from(root: Root) -> Self

impl<'a> Index<&'a [Ident]> for Module

type Output = Module

fn index(&self, path: &'a Path) -> &Self::Output

impl<'a> IndexMut<&'a [Ident]> for Module

fn index_mut(&mut self, path: &'a Path) -> &mut Self::Output

impl PartialEq<Module> for Module

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

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

impl StructuralPartialEq for Module

Auto Trait Implementations

impl RefUnwindSafe for Module

impl Send for Module

impl Sync for Module

impl Unpin for Module

impl UnwindSafe for Module

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn default_with_constants(
constants: BTreeMap<String, ConfigTimeConstant>
) -> Result<Self, Vec1<CompileError>>

pub fn apply_storage_load(
&self,
fields: Vec<Ident>,
storage_fields: &[TypedStorageField]
) -> CompileResult<(TypeCheckedStorageAccess, TypeId)>

pub fn set_storage_declaration(
&mut self,
decl: TypedStorageDeclaration
) -> CompileResult<()>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,