Struct BaseChannel 

pub struct BaseChannel { /* private fields */ }

Base channel implementation.

A BaseChannel represents an isolated execution context that can:

• Track its current state (ChannelState)
• Maintain parent-child relationships
• Control behavior via ChannelConfig
• Transition through its lifecycle
• Hold a Principal for scope resolution

Parent-Child Relationships

Channels form a tree structure:

• Primary channel has no parent (parent() == None)
• Child channels reference their parent
• A channel tracks all its children

Ancestor Path (DOD Optimization)

Each channel maintains a cached path to all ancestors for O(1) descendant checks. The path is ordered from immediate parent to root: [parent, grandparent, ..., root].

Configuration

Channel behavior is controlled by ChannelConfig:

• priority: Determines scheduling order (0-255, higher = more priority)
• can_spawn: Whether this channel can create children

Example

use orcs_runtime::{BaseChannel, ChannelConfig, ChannelCore, ChannelMut, ChannelState};
use orcs_types::{ChannelId, Principal};

// Create a root channel
let root_id = ChannelId::new();
let mut root = BaseChannel::new(root_id, None, ChannelConfig::interactive(), Principal::System);
assert_eq!(root.priority(), 255);
assert!(root.can_spawn());

// Create a background child channel
let child_id = ChannelId::new();
let child = BaseChannel::new(child_id, Some(root_id), ChannelConfig::background(), Principal::System);
assert_eq!(child.priority(), 10);
assert!(!child.can_spawn());

root.add_child(child_id);
assert!(root.has_children());

Implementations

impl BaseChannel

pub fn new( id: ChannelId, parent: Option<ChannelId>, config: ChannelConfig, principal: Principal, ) -> Self

Creates a new channel in Running state.

Arguments

• id - Unique identifier for this channel
• parent - Parent channel ID, or None for root channels
• config - Configuration controlling channel behavior
• principal - Principal for scope resolution

Note

The ancestor_path is initialized empty. When spawning via World, use new_with_ancestors to properly set the ancestor path.

Example

use orcs_runtime::{BaseChannel, ChannelConfig, ChannelCore};
use orcs_types::{ChannelId, Principal};

// Primary channel (no parent, highest priority)
let root = BaseChannel::new(ChannelId::new(), None, ChannelConfig::interactive(), Principal::System);
assert_eq!(root.priority(), 255);

// Background child channel
let parent_id = ChannelId::new();
let child = BaseChannel::new(ChannelId::new(), Some(parent_id), ChannelConfig::background(), Principal::System);
assert_eq!(child.priority(), 10);

pub fn new_with_ancestors( id: ChannelId, parent: ChannelId, config: ChannelConfig, principal: Principal, ancestor_path: Vec<ChannelId>, ) -> Self

Creates a new channel with a pre-computed ancestor path.

This constructor is used by World when spawning child channels to maintain the ancestor path for O(1) descendant checks.

Arguments

• id - Unique identifier for this channel
• parent - Parent channel ID
• config - Configuration controlling channel behavior
• principal - Principal for scope resolution
• ancestor_path - Pre-computed path: [parent, grandparent, …, root]

Trait Implementations

impl ChannelCore for BaseChannel

fn id(&self) -> ChannelId

Returns the channel’s unique identifier.

fn principal(&self) -> &Principal

Returns the principal associated with this channel.

fn state(&self) -> &ChannelState

Returns a reference to the current state.

fn config(&self) -> &ChannelConfig

Returns a reference to the channel’s configuration.

fn parent(&self) -> Option<ChannelId>

Returns the parent channel’s ID, if any.

fn children(&self) -> &HashSet<ChannelId>

Returns a reference to the set of child channel IDs.

fn ancestor_path(&self) -> &[ChannelId]

Returns the cached ancestor path.

fn is_running(&self) -> bool

Returns true if the channel is in Running state.

fn is_paused(&self) -> bool

Returns true if the channel is in Paused state.

fn is_awaiting_approval(&self) -> bool

Returns true if the channel is in AwaitingApproval state.

fn is_terminal(&self) -> bool

Returns true if the channel is in a terminal state (Completed or Aborted).

fn priority(&self) -> u8

Returns the scheduling priority (0-255).

fn can_spawn(&self) -> bool

Returns whether this channel can spawn children.

fn has_children(&self) -> bool

Returns true if this channel has any children.

fn depth(&self) -> usize

Returns the depth of this channel in the tree.

fn is_descendant_of(&self, ancestor: ChannelId) -> bool

Returns true if this channel is a descendant of the given ancestor.

impl ChannelMut for BaseChannel

fn complete(&mut self) -> bool

Transitions to Completed state.

fn abort(&mut self, reason: String) -> bool

Transitions to Aborted state.

fn pause(&mut self) -> bool

Transitions to Paused state.

fn resume(&mut self) -> bool

Transitions from Paused to Running state.

fn await_approval(&mut self, request_id: String) -> bool

Transitions to AwaitingApproval state.

fn resolve_approval(&mut self, approval_id: &str) -> Option<String>

Resolves approval and transitions to Running state.

fn add_child(&mut self, id: ChannelId)

Registers a child channel.

fn remove_child(&mut self, id: &ChannelId)

Unregisters a child channel.

impl Debug for BaseChannel

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

Formats the value using the given formatter.