Methods

Methods in Spice basically are functions / procedures, assigned to a struct. Within methods, fields of the parent struct can be accessed like this: this.fieldName.

Usage¶

A basic setup with one struct field, as well es a getter and a setter could look like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

type Letter struct {
    string content
}

f<string> Letter.getContent() {
    return this.content;
}

p Letter.setContent(string text) {
    this.content = text;
}

f<int> main() {
    dyn letter = Letter { "No content" };
    letter.setContent("Hello World!");
    printf("Content: %s", letter.getContent());
}

Output:

1

Content: Hello World!

Method visibility¶

Like functions and struct fields, methods are private by default. Mark a method public to allow code in other source files to call it:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

public type Counter struct {
    int value
}

public p Counter.increment() {
    this.value++;
}

public f<int> Counter.get() {
    return this.value;
}

A method that is not marked public can only be called from within the same source file.

Methods on generic structs¶

Methods on a generic struct automatically inherit the struct's type parameters — you do not repeat the parameter list on the method:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

type T dyn;

type Stack<T> struct {
    T* data
    int size
}

p Stack.push(T item) {
    // ...
}

f<T> Stack.pop() {
    // ...
}

When Stack<int> is instantiated, push accepts an int and pop returns an int.