Struct Element 

pub struct Element {
    pub name: String,
    pub id: Option<String>,
    pub limits: Limits,
    pub children: Vec<Node>,
    pub position: Position,
}

A named grouping. Names and optional IDs have no provider role or trust meaning.

Fields

name: String

id: Option<String>

limits: Limits

children: Vec<Node>

position: Position

Implementations

impl Element

pub fn new(name: impl Into<String>) -> Self

Construct a named element with no ID. Names are validated by lint/render.

pub fn id(self, id: impl Into<String>) -> Self

pub fn text(self, value: impl Into<String>) -> Self

Append literal text. Braces, entities, and markup are never interpreted.

pub fn variable(self, name: impl Into<String>) -> Self

pub fn template(self, value: &str) -> Result<Self, Diagnostic>

Append a text template. Only {{name}} is interpreted; bindings remain literal.

pub fn element(self, element: Element) -> Self

pub fn max_tokens(self, tokens: u64, reason: impl Into<String>) -> Self

pub fn per_item(self, tokens: u64, reason: impl Into<String>) -> Self

pub fn get_element_by_id(&self, id: &str) -> Option<ElementRef<'_>>

pub fn elements(&self) -> Vec<&Element>

pub fn elements_by_name(&self, name: &str) -> Vec<&Element>

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Element

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Element

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Element

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

Formats the value using the given formatter.

impl Eq for Element

impl From<Element> for Node

fn from(element: Element) -> Self

Converts to this type from the input type.

impl JsonSchema for Element

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Element

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Element

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Element