Skip to main content

Schema

Struct Schema 

Source
pub struct Schema {
Show 21 fields pub protocol: String, pub vertices: HashMap<Name, Vertex>, pub edges: HashMap<Edge, Name>, pub hyper_edges: HashMap<Name, HyperEdge>, pub constraints: HashMap<Name, Vec<Constraint>>, pub required: HashMap<Name, Vec<Edge>>, pub nsids: HashMap<Name, Name>, pub entries: Vec<Name>, pub variants: HashMap<Name, Vec<Variant>>, pub orderings: HashMap<Edge, u32>, pub recursion_points: HashMap<Name, RecursionPoint>, pub spans: HashMap<Name, Span>, pub usage_modes: HashMap<Edge, UsageMode>, pub nominal: HashMap<Name, bool>, pub coercions: HashMap<(Name, Name), CoercionSpec>, pub mergers: HashMap<Name, Expr>, pub defaults: HashMap<Name, Expr>, pub policies: HashMap<Name, Expr>, pub outgoing: HashMap<Name, SmallVec<Edge, 4>>, pub incoming: HashMap<Name, SmallVec<Edge, 4>>, pub between: HashMap<(Name, Name), SmallVec<Edge, 2>>,
}
Expand description

A schema: a model of the protocol’s schema theory.

Contains both the raw data (vertices, edges, constraints, etc.) and precomputed adjacency indices for efficient graph traversal.

Fields§

§protocol: String

The protocol this schema belongs to.

§vertices: HashMap<Name, Vertex>

Vertices keyed by their ID.

§edges: HashMap<Edge, Name>

Edges keyed by the edge itself, value is the edge kind.

§hyper_edges: HashMap<Name, HyperEdge>

Hyper-edges keyed by their ID.

§constraints: HashMap<Name, Vec<Constraint>>

Constraints per vertex ID.

§required: HashMap<Name, Vec<Edge>>

Required edges per vertex ID.

§nsids: HashMap<Name, Name>

NSID mapping: vertex ID to NSID string.

§entries: Vec<Name>

Declared entry vertices.

Semantically, this is the finite family of basepoints that makes the schema a pointed schema: E → Ob(C_S) selecting the sorts at which the W-algebra of instances may be rooted. Parsers set this explicitly per their protocol’s notion of a top-level definition (a record, a top-level type, a path root, etc.); consumers that need to choose an instance root consult it via primary_entry.

Empty means the parser declined to supply a pointing; consumers should then either fall back to a deterministic (but non- canonical) selection or report an error. Order is preserved for reproducibility; the set carries no duplicates.

§variants: HashMap<Name, Vec<Variant>>

Coproduct variants per union vertex ID.

§orderings: HashMap<Edge, u32>

Edge ordering positions (edge → position index).

§recursion_points: HashMap<Name, RecursionPoint>

Recursion points (fixpoint markers).

§spans: HashMap<Name, Span>

Spans connecting pairs of vertices.

§usage_modes: HashMap<Edge, UsageMode>

Edge usage modes (default: Structural for all).

§nominal: HashMap<Name, bool>

Whether each vertex uses nominal identity (true) or structural identity (false). Absent = structural.

§coercions: HashMap<(Name, Name), CoercionSpec>

Coercion specifications: (source_kind, target_kind) to coercion spec.

§mergers: HashMap<Name, Expr>

Merger expressions: vertex_id to merger expression.

§defaults: HashMap<Name, Expr>

Default value expressions: vertex_id to default expression.

§policies: HashMap<Name, Expr>

Conflict resolution policy expressions: sort_name to policy expression.

§outgoing: HashMap<Name, SmallVec<Edge, 4>>

Outgoing edges per vertex ID.

§incoming: HashMap<Name, SmallVec<Edge, 4>>

Incoming edges per vertex ID.

§between: HashMap<(Name, Name), SmallVec<Edge, 2>>

Edges between a specific (src, tgt) pair.

Implementations§

Source§

impl Schema

Source

pub fn forget_layout(&self) -> Self

Strip every constraint whose sort belongs to the layout enrichment fibre (per panproto_gat::is_layout_sort).

This is the schema-level forgetful U sending a decorated schema to its abstract base in the parse/decorate/emit lens. Idempotent.

Source

pub fn forget_layout_in_place(&mut self)

In-place variant of Self::forget_layout.

Source

pub fn is_layout_free(&self) -> bool

Returns true when no constraint sort belongs to the layout enrichment fibre. This is the well-formedness predicate for an AbstractSchema.

Source

pub fn vertex(&self, id: &str) -> Option<&Vertex>

Look up a vertex by ID.

Source

pub fn outgoing_edges(&self, vertex_id: &str) -> &[Edge]

Return all outgoing edges from the given vertex.

Source

pub fn incoming_edges(&self, vertex_id: &str) -> &[Edge]

Return all incoming edges to the given vertex.

Source

pub fn edges_between(&self, src: &str, tgt: &str) -> &[Edge]

Return edges between a specific (src, tgt) pair.

Source

pub fn has_vertex(&self, id: &str) -> bool

Returns true if the given vertex ID exists in this schema.

Source

pub fn vertex_count(&self) -> usize

Returns the number of vertices in the schema.

Source

pub fn edge_count(&self) -> usize

Returns the number of edges in the schema.

Source

pub fn entry_vertices(&self) -> &[Name]

Return the declared entry vertices.

See Schema::entries for semantics. Use primary_entry for callers that need a single root and want a deterministic fallback when no entries are declared.

Source

pub fn constraints_for(&self, vertex_id: &str) -> &[Constraint]

Return every constraint attached to the given vertex.

Tree-sitter-derived schemas attach byte ranges, interstitials, formatting, and field:<name> entries here.

Source

pub fn field_text(&self, vertex_id: &str, field_name: &str) -> Option<&str>

Return the text value of a tree-sitter field('<name>', ...) anonymous-token child on the given vertex, if any.

Tree-sitter rules of the form field('op', choice('+', '-', '*', '/')) attach a field name to an unnamed token alternative. The walker emits the token’s text as a field:<name> constraint on the parent vertex; this is the supported accessor for that text.

Returns None if no field:<name> constraint exists on vertex_id. Named-node field children continue to surface as edges (use outgoing_edges and filter by Edge::kind for those).

Trait Implementations§

Source§

impl Clone for Schema

Source§

fn clone(&self) -> Schema

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 Schema

Source§

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

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

impl<'de> Deserialize<'de> for Schema

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Schema

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<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, 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<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
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 = 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,