Struct CallPath

pub struct CallPath<T = Ident> {
    pub prefixes: Vec<Ident>,
    pub suffix: T,
    pub callpath_type: CallPathType,
}

In the expression a::b::c(), a and b are the prefixes and c is the suffix. c can be any type T, but in practice c is either an Ident or a TypeInfo.

Fields

prefixes: Vec<Ident>

suffix: T

callpath_type: CallPathType

Implementations

impl CallPath

pub fn fullpath(path: &[&str]) -> Self

pub fn rshift(&self) -> CallPath

Shifts the last prefix into the suffix, and removes the old suffix. Does nothing if prefixes are empty, or if the path is a full path and there is only a single prefix (which must be the package name, which is obligatory for full paths)

pub fn lshift(&self) -> CallPath

Removes the first prefix. Does nothing if prefixes are empty.

pub fn as_vec_string(&self) -> Vec<String>

pub fn ident_to_fullpath(suffix: Ident, namespace: &Namespace) -> CallPath

Create a full CallPath from a given Ident and the Namespace in which the Ident is declared.

This function is intended to be used while typechecking the identifier declaration, i.e., before the identifier is added to the environment.

pub fn to_import_path( &self, engines: &Engines, namespace: &Namespace, ) -> CallPath

Convert a given CallPath into a call path suitable for a use statement.

For example, given a path pkga::SOME_CONST where pkga is an internal library of a package named my_project, the corresponding call path is pkga::SOME_CONST.

Paths to external libraries such std::lib1::lib2::my_obj are left unchanged.

pub fn to_display_path( &self, display_type: CallPathDisplayType, namespace: &Namespace, ) -> CallPath

impl<T: Clone> CallPath<T>

pub fn to_fullpath( &self, engines: &Engines, namespace: &Namespace, ) -> CallPath<T>

Convert a given CallPath to a symbol to a full CallPath to a program point in which the symbol can be resolved (assuming the given CallPath is a legal Sway path).

The resulting CallPath is not guaranteed to be located in the package where the symbol is declared. To obtain the path to the declaration, use [to_canonical_path].

The CallPath is converted within the current module of the supplied namespace.

For example, given a path pkga::SOME_CONST where pkga is an internal module of a package named my_project, the corresponding call path is my_project::pkga::SOME_CONST. This does not imply that SOME_CONST is declared in the my_project::pkga, but only that the name SOME_CONST is bound in my_project::pkga.

Paths to external libraries such std::lib1::lib2::my_obj are considered full already and are left unchanged since std is a root of the package std.

pub fn to_fullpath_from_mod_path( &self, engines: &Engines, namespace: &Namespace, mod_path: &Vec<Ident>, ) -> CallPath<T>

Convert a given CallPath to a symbol to a full CallPath to a program point in which the symbol can be resolved (assuming the given CallPath is a legal Sway path).

The resulting CallPath is not guaranteed to be located in the package where the symbol is declared. To obtain the path to the declaration, use [to_canonical_path].

The CallPath is converted within the module given by mod_path, which must be a legal path to a module.

For example, given a path pkga::SOME_CONST where pkga is an internal module of a package named my_project, the corresponding call path is my_project::pkga::SOME_CONST. This does not imply that SOME_CONST is declared in the my_project::pkga, but only that the name SOME_CONST is bound in my_project::pkga.

Paths to external libraries such std::lib1::lib2::my_obj are considered full already and are left unchanged since std is a root of the package std.

impl CallPath

pub fn to_canonical_path( &self, engines: &Engines, namespace: &Namespace, ) -> CallPath

Convert a given CallPath to a symbol to a full CallPath to where the symbol is declared (assuming the given CallPath is a legal Sway path).

The CallPath is converted within the current module of the supplied namespace.

For example, given a path pkga::SOME_CONST where pkga is an internal module of a package named my_project, and SOME_CONST is bound in the module my_project::pkga, then the corresponding call path is the full callpath to the declaration that SOME_CONST is bound to. This does not imply that SOME_CONST is declared in the my_project::pkga, since the binding may be the result of an import.

Paths to external libraries such std::lib1::lib2::my_obj are considered full already and are left unchanged since std is a root of the package std.

Trait Implementations

impl<T: Clone> Clone for CallPath<T>

fn clone(&self) -> CallPath<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CallPath<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for CallPath<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for CallPath<T>

where T: Display,

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

Formats the value using the given formatter.

impl From<BaseIdent> for CallPath

fn from(other: Ident) -> Self

Converts to this type from the input type.

impl From<CallPath> for QualifiedCallPath

fn from(other: CallPath) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for CallPath<T>

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<T: Ord> Ord for CallPath<T>

fn cmp(&self, other: &CallPath<T>) -> 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<T: OrdWithEngines> OrdWithEngines for CallPath<T>

fn cmp(&self, other: &Self, ctx: &OrdWithEnginesContext<'_>) -> Ordering

impl<T: PartialEq> PartialEq for CallPath<T>

fn eq(&self, other: &CallPath<T>) -> 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 PartialEqWithEngines for CallPath

fn eq(&self, other: &Self, _ctx: &PartialEqWithEnginesContext<'_>) -> bool

impl<T: PartialEqWithEngines> PartialEqWithEngines for CallPath<T>

fn eq(&self, other: &Self, ctx: &PartialEqWithEnginesContext<'_>) -> bool

impl<T: PartialOrd> PartialOrd for CallPath<T>

fn partial_cmp(&self, other: &CallPath<T>) -> 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 ResolveSymbols for CallPath

fn resolve_symbols( &mut self, _handler: &Handler, _ctx: SymbolResolveContext<'_>, )

impl<T> Serialize for CallPath<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Spanned> Spanned for CallPath<T>

fn span(&self) -> Span

impl<T: Eq> Eq for CallPath<T>

impl EqWithEngines for CallPath

impl<T: EqWithEngines> EqWithEngines for CallPath<T>

impl<T> StructuralPartialEq for CallPath<T>