Skip to content

Stream

BuilderStream dataclass

Represents a stream of builder nodes.

eat 

eat(types, skips=None)

Scan the stream until a node of type in types or skips is found.

Parameters:

Name Type Description Default
types List[Type[Builder]]

List of types to move the stream pointer to

 required
skips List[Type[Builder]] | None

List of types to end the

 None

Returns:

Name Type Description
BuilderNode BuilderNode

The beginning of the stream which matches a type in types.
Source code in src/bloqade/builder/parse/stream.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def eat(
    self, types: List[Type[Builder]], skips: Optional[List[Type[Builder]]] = None
) -> BuilderNode:
    """Scan the stream until a node of type in `types` or `skips` is found.

    Args:
        types (List[Type[Builder]]): List of types to move the stream pointer to
        skips (List[Type[Builder]] | None, optional): List of types to end the
        stream scan

    Returns:
        BuilderNode: The beginning of the stream which matches a type in `types`.
    """
    head = self.read_next(types)
    curr = head
    while curr is not None:
        if type(curr.node) not in types:
            if skips and type(curr.node) not in skips:
                break
        curr = curr.next
    self.curr = curr
    return head