Struct ChannelConfig

Source

pub struct ChannelConfig { /* private fields */ }

Expand description

Configuration for a Channel.

Defines behavioral attributes without requiring separate types. This approach allows flexible channel behavior while maintaining a simple, unified Channel struct.

§Privilege Inheritance

When spawning child channels, max_privilege is inherited:

Child cannot exceed parent’s max_privilege
Use inherit_from() to apply inheritance

§Example

use orcs_runtime::{ChannelConfig, MaxPrivilege};

let config = ChannelConfig::interactive();
assert!(config.can_spawn());
assert_eq!(config.priority(), 255);
assert_eq!(config.max_privilege(), MaxPrivilege::Elevated);

let bg = ChannelConfig::background();
assert!(!bg.can_spawn());
assert_eq!(bg.max_privilege(), MaxPrivilege::Standard);

Implementations§

Source §

impl ChannelConfig

Source

pub const fn new(priority: u8, can_spawn: bool) -> Self

Creates a new configuration with specified attributes.

Uses MaxPrivilege::Standard by default. For elevated channels, use with_max_privilege().

§Arguments

priority - Scheduling priority (0-255)
can_spawn - Whether child channels can be spawned

§Example

use orcs_runtime::ChannelConfig;

let config = ChannelConfig::new(100, true);
assert_eq!(config.priority(), 100);
assert!(config.can_spawn());

Source

pub const fn interactive() -> Self

Configuration for interactive channels.

Interactive channels:

Have highest priority (255)
Can spawn child channels
Have elevated privilege capability
Used for Human direct interaction (IO)

§Example

use orcs_runtime::{ChannelConfig, MaxPrivilege};

let config = ChannelConfig::interactive();
assert_eq!(config.priority(), 255);
assert!(config.can_spawn());
assert_eq!(config.max_privilege(), MaxPrivilege::Elevated);

Source

pub const fn background() -> Self

Configuration for background channels.

Background channels:

Have lowest priority (10)
Cannot spawn child channels
Have standard privilege only
Used for parallel/async tasks

§Example

use orcs_runtime::{ChannelConfig, MaxPrivilege};

let config = ChannelConfig::background();
assert_eq!(config.priority(), 10);
assert!(!config.can_spawn());
assert_eq!(config.max_privilege(), MaxPrivilege::Standard);

Source

pub const fn tool() -> Self

Configuration for tool execution channels.

Tool channels:

Have medium-high priority (100)
Can spawn child channels (for sub-tools)
Have elevated privilege capability
Spawned for specific operations

§Example

use orcs_runtime::{ChannelConfig, MaxPrivilege};

let config = ChannelConfig::tool();
assert_eq!(config.priority(), 100);
assert!(config.can_spawn());
assert_eq!(config.max_privilege(), MaxPrivilege::Elevated);

Source

pub const fn priority(&self) -> u8

Returns the scheduling priority.

Higher values indicate higher priority for scheduling.

Source

pub const fn can_spawn(&self) -> bool

Returns whether this channel can spawn children.

Source

pub const fn max_privilege(&self) -> MaxPrivilege

Returns the maximum privilege level.

Source

pub const fn with_priority(self, priority: u8) -> Self

Returns a new config with the specified priority.

Source

pub const fn with_spawn(self, can_spawn: bool) -> Self

Returns a new config with spawn permission set.

Source

pub const fn with_max_privilege(self, max_privilege: MaxPrivilege) -> Self

Returns a new config with the specified max privilege.

Source

pub fn inherit_from(self, parent: &ChannelConfig) -> Self

Returns a config that inherits constraints from a parent.

The child’s max_privilege is capped by the parent’s level. This ensures privilege reduction propagates down the channel tree.

§Example

use orcs_runtime::{ChannelConfig, MaxPrivilege};

let parent = ChannelConfig::background(); // Standard privilege
let child_request = ChannelConfig::tool(); // Elevated privilege

let actual = child_request.inherit_from(&parent);
// Child is capped to parent's Standard level
assert_eq!(actual.max_privilege(), MaxPrivilege::Standard);