Skip to main content

DocumentSection

Struct DocumentSection 

Source
pub struct DocumentSection {
Show 13 fields pub id: String, pub language: String, pub content_path: PathBuf, pub component_id: String, pub feed_channel: String, pub authoring_channel: String, pub state_dir: PathBuf, pub lease_expiry_ms: u64, pub journal_length_bound: u64, pub quiesce_window_ms: u64, pub dark_theme: bool, pub blink_interval_ms: u64, pub syntax_theme: Option<BTreeMap<String, String>>,
}
Expand description

The [document] section (IRIDIUM-A3 R11): the document binding.

Deployment-identity fields (id, language, content_path, component_id, feed_channel, authoring_channel, state_dir) stay fully required — A1 constraint 9’s no-assumed-defaults law still governs them, since each one is a genuinely deployment-specific decision with no single “the” value. The five pure tuning/presentation knobs below (lease_expiry_ms, journal_length_bound, quiesce_window_ms, dark_theme, blink_interval_ms) are amended by the 2026-07-21 BINDING ruling (the same amendment that gave syntax_theme its built-in default): every known deployment types the identical value, so requiring the operator to retype it is exactly the “stupid required key” the ruling forbids. frame_authority::AuthorityConfig::declare (constraint 9’s actual enforcement point) still receives an explicit, concrete, non-invented value either way — the default only decides where that value comes from when the key is absent.

Fields§

§id: String

The bound document id ([a-z0-9-]+).

§language: String

The document language.

§content_path: PathBuf

The initial content source, resolved relative to the config file.

§component_id: String

The component instance id on every feed envelope ([a-z0-9-]+).

§feed_channel: String

The feed channel: the service publishes; every page subscribes.

§authoring_channel: String

The authoring channel: pages publish; the service subscribes.

§state_dir: PathBuf

The frame-state store directory, resolved relative to the config file.

§lease_expiry_ms: u64

Lease expiry (§5.5 policy), milliseconds. Optional — absent defaults to DEFAULT_LEASE_EXPIRY_MS, the value every known [document]-enabled deployment declares (examples/code-view-console/frame.toml, matching the live deployed demo ~/.frame-demo/code-view/frame.toml). A present-but-zero value still refuses loudly (FrameConfig::check_document_contract).

§journal_length_bound: u64

The journal-length snapshot bound (T3(i) signal 3). Optional — absent defaults to DEFAULT_JOURNAL_LENGTH_BOUND, sourced the same way as Self::lease_expiry_ms.

§quiesce_window_ms: u64

The quiesce debounce window (T3(i) signal 4), milliseconds. Optional — absent defaults to DEFAULT_QUIESCE_WINDOW_MS, sourced the same way as Self::lease_expiry_ms.

§dark_theme: bool

The publisher-seat dark-mode presentation input (C5). Optional — absent defaults to DEFAULT_DARK_THEME, sourced the same way as Self::lease_expiry_ms.

§blink_interval_ms: u64

The component’s cursor-blink interval (T4), milliseconds — a component policy value carried by frame.toml per constraint 12 and advertised to the page. Optional — absent defaults to DEFAULT_BLINK_INTERVAL_MS, sourced the same way as Self::lease_expiry_ms.

§syntax_theme: Option<BTreeMap<String, String>>

The publisher-seat syntax-theme presentation input (C5, amended 2026-07-21): capture-name → #rrggbb hex colour, TOML table. Optional — when absent, crate::doc_binding::DocBinding::boot falls back to the built-in default palette (crate::syntax_theme::default_syntax_theme, copied from the proven SYNTAX_THEME in examples/code-view-console/src/fake-feed.ts). When present, this table REPLACES the built-in default WHOLESALE — there is no per-key merging with the default (merging would invent behaviour nobody asked for). Every declared value must be #rrggbb hex; FrameConfig::load fails loudly on a malformed or non-string entry rather than dropping it silently.

Trait Implementations§

Source§

impl Debug for DocumentSection

Source§

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

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

impl<'de> Deserialize<'de> for DocumentSection

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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