Functions
- main 🔒
diff --git a/errcov/index.html b/errcov/index.html index 862677f5ee..4ce6214aa9 100644 --- a/errcov/index.html +++ b/errcov/index.html @@ -1 +1 @@ -
ty: Type
The inner struct type.
name: Identifier
The struct constant that is being accessed.
span: Span
The span for the entire expression Foo::bar()
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.name: Identifier
The static struct member function that is being accessed.
arguments: Vec<Expression>
The arguments passed to the function name
.
span: Span
The span for the entire expression Foo::bar()
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.ty: Type
The inner struct type.
name: Identifier
The struct constant that is being accessed.
span: Span
The span for the entire expression Foo::bar()
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.name: Identifier
The static struct member function that is being accessed.
arguments: Vec<Expression>
The arguments passed to the function name
.
span: Span
The span for the entire expression Foo::bar()
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.value: String
The string representation of the positive number.
source
. Read moresource
. Read moreself
and other
values to be equal, and is used
by ==
.!=
. The default implementation is almost always
diff --git a/leo_ast/common/static_string/struct.StaticString.html b/leo_ast/common/static_string/struct.StaticString.html
index c957906183..f4c2bf07c0 100644
--- a/leo_ast/common/static_string/struct.StaticString.html
+++ b/leo_ast/common/static_string/struct.StaticString.html
@@ -1,5 +1,5 @@
-pub struct StaticString(String);
0: String
source
. Read moreself
and other
values to be equal, and is used
+pub struct StaticString(String);
0: String
source
. Read moreself
and other
values to be equal, and is used
by ==
.Access to an associated function of a struct e.g Pedersen64::hash()
.
An expression accessing a field in a structure, e.g., struct_var.field
.
Access to a tuple field using its position, e.g., tuple.1
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.right: Box<Expression>
The right operand of the expression.
op: BinaryOperation
The operand defining the meaning of the resulting binary expression.
span: Span
The span from left
to right
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.arguments: Vec<Expression>
Expressions for the arguments passed to the functions parameters.
external: Option<Box<Expression>>
The name of the external program call, e.g.bar
in bar.leo
.
span: Span
Span of the entire call function(arguments)
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.expression: Box<Expression>
The expression to be casted, e.g.42u8
in 42u8 as u16
.
type_: Type
The type to be casted to, e.g. u16
in 42u8 as u16
.
span: Span
Span of the entire cast 42u8 as u16
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.Access to an associated function of a struct e.g Pedersen64::hash()
.
An expression accessing a field in a structure, e.g., struct_var.field
.
Access to a tuple field using its position, e.g., tuple.1
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.Represents a syntactically invalid expression.
span: Span
The span of the invalid expression.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.right: Box<Expression>
The right operand of the expression.
op: BinaryOperation
The operand defining the meaning of the resulting binary expression.
span: Span
The span from left
to right
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.arguments: Vec<Expression>
Expressions for the arguments passed to the functions parameters.
external: Option<Box<Expression>>
The name of the external program call, e.g.bar
in bar.leo
.
span: Span
Span of the entire call function(arguments)
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.expression: Box<Expression>
The expression to be casted, e.g.42u8
in 42u8 as u16
.
type_: Type
The type to be casted to, e.g. u16
in 42u8 as u16
.
span: Span
Span of the entire cast 42u8 as u16
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.Represents a syntactically invalid expression.
span: Span
The span of the invalid expression.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.span: Span
A span from name
to }
.
Returns true if the record has all required fields and visibility.
Returns the struct as a record interface with visibility.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.elements: Vec<Expression>
The elements of the tuple.
In the example above, it would be foo
, false
, and 42
.
span: Span
The span from (
to )
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.receiver: Box<Expression>
The inner expression op
is applied to.
op: UnaryOperation
The unary operator to apply to inner
.
span: Span
The span covering op inner
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.Represents a unit expression.
span: Span
The span of the unit expression.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.span: Span
A span from name
to }
.
Returns true if the record has all required fields and visibility.
Returns the struct as a record interface with visibility.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.elements: Vec<Expression>
The elements of the tuple.
In the example above, it would be foo
, false
, and 42
.
span: Span
The span from (
to )
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.receiver: Box<Expression>
The inner expression op
is applied to.
op: UnaryOperation
The unary operator to apply to inner
.
span: Span
The span covering op inner
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.Represents a unit expression.
span: Span
The span of the unit expression.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.An annotation, e.g. @program.
identifier: Identifier
The name of the annotation.
span: Span
A span locating where the annotation occurred in the source.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.program_name: Identifier
The name of the external program.
record: Identifier
The name of the external record type.
span: Span
The parameters span from any annotations to its type.
-self
and other
values to be equal, and is used
+Create a new finalize block.
-pub enum Input {
Internal(FunctionInput),
External(External),
-}
self
and other
values to be equal, and is used
+}The abstract syntax tree (ast) for a Leo program.
+The abstract syntax tree (ast) for a Leo program.
This module contains the Ast
type, a wrapper around the Program
type.
The Ast
type is intended to be parsed and modified by different passes
of the Leo compiler. The Leo compiler can generate a set of R1CS constraints from any Ast
.
source
. Read moreself
and other
values to be equal, and is used
+}source
. Read moreself
and other
values to be equal, and is used
by ==
.key_type: Type
The type of the key.
value_type: Type
The type of the value.
span: Span
The entire span of the mapping declaration.
-self
and other
values to be equal, and is used
+Stores the Leo program abstract syntax tree.
imports: IndexMap<Symbol, (Program, Span)>
A map from import names to import definitions.
program_scopes: IndexMap<ProgramId, ProgramScope>
A map from program names to program scopes.
-Constructs an empty program node.
+self
and other
values to be equal, and is used
+ __D: Deserializer<'de>,A block { [stmt]* }
consisting of a list of statements to execute in order.
statements: Vec<Statement>
The list of statements to execute.
span: Span
The span from {
to }
.
self
and other
values to be equal, and is used
+then: Block
The block to evaluate in case condition
yields true
.
otherwise: Option<Box<Statement>>
The statement, if any, to evaluate when condition
yields false
.
span: Span
The span from if
to next
or to block
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.A console.assert(expr)
call to invoke, asserting that the expression evaluates to true.
A console.assert_eq(expr1, expr2)
call to invoke, asserting that the operands are equal.
A console.assert_neq(expr1, expr2)
call to invoke, asserting that the operands are not equal.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.A console logging statement like console.log(...);
.
function: ConsoleFunction
The logging function to run.
span: Span
The span excluding the semicolon.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.A for
statement.
A return statement return expr;
.
An expression statement, foo(a);
.
expression: Expression
The expression associated with the statement.
span: Span
The span.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.=
when parsing.
block: Block
The block to run on each iteration.
span: Span
The span from for
to block
.
source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.type_: Type
The type of the member.
span: Span
The span of the member.
span: Span
The entire span of the struct definition.
A mapping type of a key and value type.
-key: Box<Type>
§value: Box<Type>
source
. Read morekey: Box<Type>
§value: Box<Type>
source
. Read moreself
and other
values to be equal, and is used
by ==
.!=
. The default implementation is almost always
diff --git a/leo_ast/value/enum.Value.html b/leo_ast/value/enum.Value.html
index 112b5315bc..4c59b2c504 100644
--- a/leo_ast/value/enum.Value.html
+++ b/leo_ast/value/enum.Value.html
@@ -17,10 +17,10 @@
U128(u128, Span),
Scalar(String, Span),
String(String, Span),
-}self
and other
values to be equal, and is used
+}Gets a unique error identifier.
Gets a unique warning identifier.
-self
and other
values to be equal, and is used
diff --git a/leo_errors/common/formatted/struct.Formatted.html b/leo_errors/common/formatted/struct.Formatted.html
index 11b43fe47d..06cb25195d 100644
--- a/leo_errors/common/formatted/struct.Formatted.html
+++ b/leo_errors/common/formatted/struct.Formatted.html
@@ -26,7 +26,7 @@
Returns an error identifier.
Returns an warning identifier.
-self
and other
values to be equal, and is used
by ==
.!=
. The default implementation is almost always
diff --git a/leo_errors/errors/ast/ast_errors/enum.AstError.html b/leo_errors/errors/ast/ast_errors/enum.AstError.html
index e8b3737642..604feaf918 100644
--- a/leo_errors/errors/ast/ast_errors/enum.AstError.html
+++ b/leo_errors/errors/ast/ast_errors/enum.AstError.html
@@ -18,7 +18,7 @@
For when a user shadows a struct.
For when a user shadows a record.
For when a user shadows a variable.
-Implements the trait for LeoError Codes.
+Implements the trait for LeoError Codes.
For when the CLI fails to self update.
For when the CLI fails to self update.
For when the CLI has an old release version.
-Implements the trait for LeoError Codes.
+Implements the trait for LeoError Codes.
source
. Read moreImplements the trait for LeoError Codes.
+) -> Selfsource
. Read moreImplements the trait for LeoError Codes.
Anyhow errors.
Returns the argument unchanged.
diff --git a/leo_errors/errors/flattener/flattener_errors/enum.FlattenError.html b/leo_errors/errors/flattener/flattener_errors/enum.FlattenError.html index 6d76c3acd2..f57b3af0e0 100644 --- a/leo_errors/errors/flattener/flattener_errors/enum.FlattenError.html +++ b/leo_errors/errors/flattener/flattener_errors/enum.FlattenError.html @@ -11,7 +11,7 @@ ) -> SelfFor when a constant operation would cause an overflow.
For when a constant operation would cause an overflow.
For when a loop uses a negative value.
-source
. Read moreImplements the trait for LeoError Codes.
+source
. Read moreImplements the trait for LeoError Codes.
For when removing a directory failed.
For when file could not be read.
-source
. Read moreImplements the trait for LeoError Codes.
+source
. Read moreImplements the trait for LeoError Codes.
source
. Read moreImplements the trait for LeoError Codes.
+) -> Selfsource
. Read moreImplements the trait for LeoError Codes.
ParserWarning enum that represents all the warnings for the leo-parser
crate.
For when a user used const on a parameter or input instead of constant.
For when a keyword is deprecated but could be used as a valid identifier.
-source
. Read moreImplements the trait for LeoError Codes.
+source
. Read moreImplements the trait for LeoError Codes.
+
The parser to convert Leo code text into an [AST
] type.
The parser to convert Leo code text into an [AST
] type.
This module contains the parse_ast()
method which calls the underlying parse()
method to create a new program ast.
token: Token
§span: Span
source
. Read moresource
. Read moreinput
string.
An enumeration of the different types of variable type.
-source
. Read moreself
and other
values to be equal, and is used
+source
. Read moreself
and other
values to be equal, and is used
by ==
.