Skip to main content

FlowDecl

brink_syntax_native::ast

Struct FlowDecl

pub struct FlowDecl { /* private fields */ }

Implementations§

impl FlowDecl

pub fn name_token(&self) -> Option<SyntaxToken>

The declared name (the IDENT immediately after flow).

pub fn param_list(&self) -> Option<ParamList>

pub fn body(&self) -> Option<Body>

The body-dialect selector chose either a prose Block (the flow default) or a code StmtBlock (the ~{ } override, §3’s “Compound guard”) — see Body.

pub fn stitches(&self) -> impl Iterator<Item = FlowDecl>

Nested flow declarations directly inside this one’s body — a stitch (charter §4: “stitches are nested flows”). Only a prose-ground body can contain one (a code-ground STMT_BLOCK’s statement grammar has no declaration-dispatch arm — parser/stmt.rs never produces a FLOW_DECL child), so a ~{ }-bodied flow simply yields none here, same as an empty body would.

pub fn return_type(&self) -> Option<TypeAnnotation>

The header’s : type return clause, if written (NG-C, #1489). Declaring one is the ruled coroutine-vs-state toggle: a flow with a return type must produce a value, and (unlike a plain flow) does not pick up the implicit -> DONE on fall-through.

pub fn doc(&self) -> Option<DocComment>

The leading /// doc comment, if one is attached (B0.6b).

pub fn is_pub(&self) -> bool

true if a pub keyword precedes this header (issue #1582, RULED 2026-08-03): opts the declaration into VisibilityMark::Public (hir::lower_native::container::lower_top_level_container/ lower_stitch read this to populate Knot/Stitch::visibility). Absent, the declaration stays Private — the already-ratified 2026-07-23 default, unchanged by this accessor.

impl FlowDecl

pub fn tags(&self) -> impl Iterator<Item = Tag>

Trailing #tags on the flow header line — container-level per-flow tags (§8b.4, the authoring surface issue #474’s per-flow tag APIs were iceboxed waiting for). Parsed here; the runtime-side API is #474’s own work, so hir::lower_native reports them as not-yet-lowered rather than dropping them.

Trait Implementations§

impl AstNode for FlowDecl

fn can_cast(kind: SyntaxKind) -> bool

Returns true for a node with a SyntaxKind this type can wrap.

fn cast(node: SyntaxNode) -> Option<Self>

Try to cast a generic SyntaxNode into this typed wrapper.

fn syntax(&self) -> &SyntaxNode

Access the underlying SyntaxNode.

impl Clone for FlowDecl

fn clone(&self) -> FlowDecl

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for FlowDecl

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

Formats the value using the given formatter. Read more

impl Display for FlowDecl

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

Formats the value using the given formatter. Read more

impl Eq for FlowDecl

impl Hash for FlowDecl

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for FlowDecl

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for FlowDecl

Auto Trait Implementations§

impl !RefUnwindSafe for FlowDecl

impl !Send for FlowDecl

impl !Sync for FlowDecl

impl !UnwindSafe for FlowDecl

impl Freeze for FlowDecl

impl Unpin for FlowDecl

impl UnsafeUnpin for FlowDecl

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.