Skip to main content

Charter

Struct Charter 

Source
pub struct Charter { /* private fields */ }
Expand description

The owner’s charter, in file order.

Order is rank. See the module doc — there is no field for it because a second statement of priority disagrees with the first the moment either is edited, the same rule TASK-AGENT-DESIGN.md R1 gives task urgency.

Implementations§

Source§

impl Charter

Source

pub fn default_path() -> Result<PathBuf>

~/.mecha/charter.toml — the only path there is. See the module doc: this is deliberately not a Config field, because a configurable path is a path a project layer could set.

Source

pub fn load(path: &Path) -> Result<Charter>

Read and validate path. A missing file is an empty charter, not an error — a machine nobody has written one for yet must still start, on crate::skill::SkillStore::load’s rule for a missing directory.

Source

pub fn parse(text: &str) -> Result<Charter>

Parse and validate charter TOML that has not been written anywhere yet. The seam a surface that accepts an edit needs — the web settings page validates a proposed charter with exactly the reader every run will load it through, and refuses the save on an error, so a file that reaches disk is one that will load. load goes through here so the two can never diverge on what “valid” means.

Source

pub fn lines(&self) -> &[CharterLine]

Source

pub fn char_count(&self) -> usize

How many characters the charter actually costs when rendered into the system prompt — prompt_block’s own length, not just the authored id/text content. The header and the per-line "N. id — " formatting ride in the cached prefix too, so measuring only the authored text would under-report the true cost by a few hundred characters of fixed overhead. What Charter::over_budget checks against CHARTER_CHAR_BUDGET, and the same number every message that quotes “characters” beside “the prompt” means.

Source

pub fn over_budget(&self) -> bool

Costs more of the cached prefix than CHARTER_CHAR_BUDGET argues for. Not refused by Charter::load — see its doc comment — so a caller that cares (today: mecha doctor) checks this after loading.

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl Clone for Charter

Source§

fn clone(&self) -> Charter

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
Source§

impl Debug for Charter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Charter

Source§

fn default() -> Charter

Returns the “default value” for a type. Read more
Source§

impl Eq for Charter

Source§

impl PartialEq for Charter

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Charter

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more